# Reporting Tables

## Documentation for package ‘rtables’ version 0.6.7

- DESCRIPTION file.
- Package NEWS.

## Help Pages

A B C D E F G H I K L M N O P Q R S T U V misc

## -- A --

additional_fun_params | Additional parameters within analysis and content functions ('afun'/'cfun')
add_colcounts | Add the column population counts to the header
add_combo_facet | Add a combination facet in post-processing
add_combo_levels | Add combination levels to split
add_existing_table | Add an already calculated table to the layout
add_overall_col | Add overall column
add_overall_facet | Add a combination facet in post-processing
add_overall_level | Add a virtual "overall" level to split
add_to_split_result | Construct split result object
all_zero | Trimming and pruning criteria
all_zero_or_na | Trimming and pruning criteria
analyze | Generate rows analyzing variables across columns
AnalyzeColVarSplit | Define a subset tabulation/analysis
AnalyzeMultiVars | Define a subset tabulation/analysis
AnalyzeVarSplit | Define a subset tabulation/analysis
analyze_colvars | Generate rows analyzing different variables across columns
append_topleft | Append a description to the 'top-left' materials for the layout
as.vector-method | Convert to a vector
assert_valid_table | Validate and assert valid table structure
asvec | Convert to a vector
as_html | Convert an 'rtable' object to a 'shiny.tag' HTML object
as_result_df | Generate a result data frame

## -- B --

basic_table | Layout with 1 column and zero rows
brackets | Retrieve and assign elements of a 'TableTree'
build_table | Create a table from a layout and data

## -- C --

cbind_rtables | Column-bind two 'TableTree' objects
CellValue | Constructor for Cell Value
cell_footnotes | Referential footnote accessors
cell_footnotes<- | Referential footnote accessors
cell_values | Retrieve cell values by row and column path
clayout | Column information/structure accessors
clayout-method | Column information/structure accessors
clayout<- | Column information/structure accessors
clayout<--method | Column information/structure accessors
clear_indent_mods | Clear all indent modifiers from a table
clear_indent_mods-method | Clear all indent modifiers from a table
collect_leaves | Collect leaves of a 'TableTree'
coltree | Column information/structure accessors
coltree-method | Column information/structure accessors
col_counts | Column information/structure accessors
col_counts-method | Column information/structure accessors
col_counts<- | Column information/structure accessors
col_counts<--method | Column information/structure accessors
col_exprs | Column information/structure accessors
col_exprs-method | Column information/structure accessors
col_fnotes_here | Referential footnote accessors
col_fnotes_here-method | Referential footnote accessors
col_fnotes_here<- | Referential footnote accessors
col_footnotes | Referential footnote accessors
col_footnotes<- | Referential footnote accessors
col_info | Column information/structure accessors
col_info-method | Column information/structure accessors
col_info<- | Column information/structure accessors
col_info<--method | Column information/structure accessors
col_paths | Get a list of table row/column paths
col_paths_summary | Print row/column paths summary
col_total | Column information/structure accessors
col_total-method | Column information/structure accessors
col_total<- | Column information/structure accessors
col_total<--method | Column information/structure accessors
compare_rtables | Compare two rtables
compat_args | Compatibility argument conventions
ContentRow | Row classes and constructors
ContentRow-class | Row classes and constructors
content_all_zeros_nas | Trimming and pruning criteria
content_table | Retrieve or set content table from a 'TableTree'
content_table<- | Retrieve or set content table from a 'TableTree'
cont_n_allcols | Score functions for sorting 'TableTrees'
cont_n_onecol | Score functions for sorting 'TableTrees'
counts_wpcts | Analysis function to count levels of a factor with percentage of the column total
CumulativeCutSplit-class | Splits for cutting by values of a numeric variable
custom_split_funs | Custom split functions

## -- D --

data.frame_export | Generate a result data frame
DataRow | Row classes and constructors
DataRow-class | Row classes and constructors
df_to_tt | Create an 'ElementaryTable' from a 'data.frame'
dim-method | Table dimensions
do_base_split | Apply basic split (for use in custom split functions)
drop_and_remove_levels | Split functions
drop_facet_levels | Pre-processing function for use in 'make_split_fun'
drop_split_levels | Split functions

## -- E --

ElementaryTable | 'TableTree' classes
ElementaryTable-class | 'TableTree' classes
EmptyAllSplit | Empty table, column, split objects
EmptyColInfo | Empty table, column, split objects
EmptyElTable | Empty table, column, split objects
EmptyRootSplit | Empty table, column, split objects
export_as_docx | Export as word document
export_as_tsv | Create enriched flat value table with paths

## -- F --

find_degen_struct | Find degenerate (sub)structures within a table
fnotes_at_path<- | Referential footnote accessors
formatters_methods | Methods for generics in the 'formatters' package
format_rcell | Format 'rcell' objects

## -- G --

get_cell_aligns | Get formatted cells
get_cell_aligns-method | Get formatted cells
get_formatted_cells | Get formatted cells
get_formatted_cells-method | Get formatted cells

## -- H --

head | Head and tail methods
head-method | Head and tail methods
header_section_div | Section dividers accessor and setter
header_section_div-method | Section dividers accessor and setter
header_section_div<- | Section dividers accessor and setter
header_section_div<--method | Section dividers accessor and setter
horizontal_sep | Access or recursively set header-body separator for tables
horizontal_sep-method | Access or recursively set header-body separator for tables
horizontal_sep<- | Access or recursively set header-body separator for tables
horizontal_sep<--method | Access or recursively set header-body separator for tables

## -- I --

import_from_tsv | Create enriched flat value table with paths
indent | Change indentation of all 'rrows' in an 'rtable'
indent_string | Indent strings
insert_row_at_path | Insert row at path
insert_row_at_path-method | Insert row at path
insert_rrow | *Deprecated:* Insert 'rrow's at (before) a specific location
InstantiatedColumnInfo | Instantiated column info
InstantiatedColumnInfo-class | Instantiated column info
in_rows | Create multiple rows in analysis or summary functions
is_rtable | Check if an object is a valid 'rtable'

## -- K --

keep_split_levels | Split functions

## -- L --

LabelRow | Row classes and constructors
LabelRow-class | Row classes and constructors
label_at_path | Label at path
label_at_path<- | Label at path
length-method | Length of a Cell value
list_wrap_df | Returns a function that coerces the return values of a function to a list
list_wrap_x | Returns a function that coerces the return values of a function to a list
low_obs_pruner | Trimming and pruning criteria

## -- M --

main_footer-method | Methods for generics in the 'formatters' package
main_footer<--method | Methods for generics in the 'formatters' package
main_title-method | Methods for generics in the 'formatters' package
main_title<--method | Methods for generics in the 'formatters' package
make_afun | Create a custom analysis function wrapping an existing function
make_col_df | Column layout summary
make_row_df-method | Methods for generics in the 'formatters' package
make_split_fun | Create a custom splitting function
make_split_result | Construct split result object
make_static_cut_split | Splits for cutting by values of a numeric variable
ManualSplit | Manually defined split
manual_cols | Manual column declaration
margins_landscape | Export as word document
margins_potrait | Export as word document
matrix_form-method | Transform an 'rtable' to a list of matrices which can be used for outputting
MultiVarSplit | Split between two or more different variables

## -- N --

names-method | Names of a 'TableTree'
ncol-method | Table dimensions
nlines-method | Methods for generics in the 'formatters' package
non_ref_rcell | Cell value constructors
no_colinfo | Exported for use in 'tern'
no_colinfo-method | Exported for use in 'tern'
nrow-method | Table dimensions

## -- O --

obj_avar | Row attribute accessors
obj_avar-method | Row attribute accessors
obj_format-method | Methods for generics in the 'formatters' package
obj_format<--method | Methods for generics in the 'formatters' package
obj_label-method | Methods for generics in the 'formatters' package
obj_label<--method | Methods for generics in the 'formatters' package
obj_name-method | Methods for generics in the 'formatters' package
obj_name<--method | Methods for generics in the 'formatters' package
obj_na_str-method | Methods for generics in the 'formatters' package

## -- P --

paginate_table | Pagination of a 'TableTree'
pag_tt_indices | Pagination of a 'TableTree'
path_enriched_df | Generate a result data frame
prov_footer-method | Methods for generics in the 'formatters' package
prov_footer<--method | Methods for generics in the 'formatters' package
prune_empty_level | Trimming and pruning criteria
prune_table | Recursively prune a 'TableTree'
prune_zeros_only | Trimming and pruning criteria

## -- Q --

qtable | Generalized frequency table
qtable_layout | Generalized frequency table

## -- R --

rbind | Row-bind 'TableTree' and related objects
rbind-method | Row-bind 'TableTree' and related objects
rbind2-method | Row-bind 'TableTree' and related objects
rbindl_rtables | Row-bind 'TableTree' and related objects
rcell | Cell value constructors
ref_index | Referential footnote accessors
ref_index<- | Referential footnote accessors
ref_msg | Referential footnote accessors
ref_symbol | Referential footnote accessors
ref_symbol<- | Referential footnote accessors
remove_split_levels | Split functions
reorder_split_levels | Split functions
result_df_specs | Generate a result data frame
rheader | Create a header
row.names-method | Names of a 'TableTree'
row_cells | Row attribute accessors
row_cells-method | Row attribute accessors
row_cells<- | Row attribute accessors
row_cells<--method | Row attribute accessors
row_footnotes | Referential footnote accessors
row_footnotes<- | Referential footnote accessors
row_paths | Get a list of table row/column paths
row_paths_summary | Print row/column paths summary
row_values | Row attribute accessors
row_values-method | Row attribute accessors
row_values<- | Row attribute accessors
row_values<--method | Row attribute accessors
rrow | Create an 'rtable' row
rrowl | Create an 'rtable' row from a vector or list of values
rtable | Create a table
rtablel | Create a table

## -- S --

sanitize_table_struct | Sanitize degenerate table structures
section_div | Section dividers accessor and setter
section_div-method | Section dividers accessor and setter
section_div<- | Section dividers accessor and setter
section_div<--method | Section dividers accessor and setter
section_properties_landscape | Export as word document
section_properties_portrait | Export as word document
select_all_levels | Add combination levels to split
sf_args | Split function argument conventions
simple_analysis | Default tabulation
simple_analysis-method | Default tabulation
sort_at_path | Sorting a table at a specific path
split_cols_by | Declaring a column-split based on levels of a variable
split_cols_by_cutfun | Split on static or dynamic cuts of the data
split_cols_by_cuts | Split on static or dynamic cuts of the data
split_cols_by_multivar | Associate multiple variables with columns
split_cols_by_quartiles | Split on static or dynamic cuts of the data
split_funcs | Split functions
split_rows_by | Add rows according to levels of a variable
split_rows_by_cutfun | Split on static or dynamic cuts of the data
split_rows_by_cuts | Split on static or dynamic cuts of the data
split_rows_by_multivar | Associate multiple variables with rows
split_rows_by_quartiles | Split on static or dynamic cuts of the data
spl_context | .spl_context within analysis and split functions
spl_context_to_disp_path | Translate spl_context to a path to display in error messages
spl_variable | Variable associated with a split
spl_variable-method | Variable associated with a split
subtitles-method | Methods for generics in the 'formatters' package
subtitles<--method | Methods for generics in the 'formatters' package
summarize_row_groups | Add a content row of summary counts

## -- T --

TableTree | 'TableTree' classes
TableTree-class | 'TableTree' classes
table_inset-method | Methods for generics in the 'formatters' package
table_inset<--method | Methods for generics in the 'formatters' package
table_shell | Table shells
table_shell_str | Table shells
table_structure | Summarize table
tail | Head and tail methods
tail-method | Head and tail methods
theme_docx_default | Create a 'flextable' from an 'rtables' table
top_left | Top left material
top_left-method | Top left material
top_left<- | Top left material
top_left<--method | Top left material
top_level_section_div | Section dividers accessor and setter
top_level_section_div-method | Section dividers accessor and setter
top_level_section_div<- | Section dividers accessor and setter
top_level_section_div<--method | Section dividers accessor and setter
tostring | Convert an 'rtable' object to a string
toString-method | Convert an 'rtable' object to a string
tree_children | Retrieve or set the direct children of a tree-style object
tree_children<- | Retrieve or set the direct children of a tree-style object
trim_levels_in_facets | Trim levels of another variable from each facet (post-processing split step)
trim_levels_in_group | Split functions
trim_levels_to_map | Trim levels to map
trim_rows | Trim rows from a populated table without regard for table structure
tt_at_path | Access or set table elements at specified path
tt_at_path<- | Access or set table elements at specified path
tt_to_flextable | Create a 'flextable' from an 'rtables' table

## -- U --

update_ref_indexing | Update footnote indices on a built table

## -- V --

validate_table_struct | Validate and assert valid table structure
value_at | Retrieve cell values by row and column path
value_at-method | Retrieve cell values by row and column path
value_formats | Value formats
value_formats-method | Value formats
VarDynCutSplit | Splits for cutting by values of a numeric variable
VarDynCutSplit-class | Splits for cutting by values of a numeric variable
VarLevelSplit | Split on levels within a variable
VarLevelSplit-class | Split on levels within a variable
VarLevWBaselineSplit | Split on levels within a variable
VarStaticCutSplit-class | Splits for cutting by values of a numeric variable
vars_in_layout | List variables required by a pre-data table layout
vars_in_layout-method | List variables required by a pre-data table layout
Viewer | Display an 'rtable' object in the Viewer pane in RStudio or in a browser

## -- misc --

.tablerow | Row classes and constructors
[-method | Retrieve and assign elements of a 'TableTree'
[<--method | Retrieve and assign elements of a 'TableTree'