Reference

Report Functions

Functions to define and decorate a report.

create_report()

Create a report

page_header()

Add a page header

page_footer()

Adds a page footer

add_content()

Add content to a report

options_fixed()

Set options for a fixed-width report

set_margins()

Set page margins

write_report()

Write a report to the file system

print(<report_spec>)

Prints the report specification

Table Functions

Functions to define and lay out a table.

create_table()

Create a table

column_defaults()

Set default attributes for one or more columns

spanning_header()

Defines a spanning header

stub()

Defines a report stub

define()

Defines a column

print(<table_spec>)

Prints the table spec

Plot and Text Functions

Functions to define plots and text content.

create_plot()

Create plot content

print(<plot_spec>)

Prints the plot spec

create_text()

Create text content

print(<text_spec>)

Prints the text spec

Title and Footnote Functions

Functions to create titles and footnotes.

titles()

Adds a title block

footnotes()

Adds a footnote block

title_header()

Adds a title header block

page_by()

Adds a page by variable

Styling Functions

Functions to create styles and apply/view themes.

create_style()

Creates a style object

add_style()

Add a style object to a report.

get_theme()

Get a theme

print(<style_spec>)

Prints a style specification

cell_style()

A style specification for a table cell

Other Functions

Here are some other functions included in the reporter package.

write_registration_file()

Create a registration file

lowcase_parens() upcase_parens() lowcase_n() upcase_n()

Functions to format the population label

ttl()

Creates a title attribute

ftn()

Creates a footnote attribute

span()

Defines a spanning header attribute