Reporting Tables

Documentation for package ‘rtables’ version 0.6.1

Help Pages

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

-- A --

add_colcounts	Add the column population counts to the header
add_combo_facet	Add a combination facet in postprocessing
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 postprocessing
add_overall_level	Add an 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
asvec	convert to a vector
as_html	Convert an 'rtable' object to a 'shiny.tag' html object

-- 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	cbind two rtables
CellValue	Cell Value constructor
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 Mods from a Table
clear_indent_mods-method	Clear All Indent Mods from a Table
collect_leaves	Collect leaves of a table tree
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<-	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	Return List with Table Row/Col Paths
col_paths_summary	Print Row/Col 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 Arg Conventions
constr_args	Constructor Arg 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 --

DataRow	Row classes and constructors
DataRow-class	Row classes and constructors
df_to_tt	Create ElementaryTable from 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	Preprocessing Functions 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_pdf	Export as PDF
export_as_tsv	Create Enriched flat value table with paths

-- F --

fnotes_at_path<-	Referential Footnote Accessors
formatters_methods	Methods for generics in the formatters package
format_rcell	Format rcell

-- G --

gen_args	General Argument Conventions
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
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 rrows at (before) a specific location
InstantiatedColumnInfo	InstantiatedColumnInfo
InstantiatedColumnInfo-class	InstantiatedColumnInfo
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 f to a list
list_wrap_x	Returns a function that coerces the return values of f to a list
low_obs_pruner	Trimming and Pruning Criteria
lyt_args	Layouting Function Arg Conventions

-- 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 custom analysis function wrapping 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
matrix_form-method	Transform 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	Transform TableTree object to Path-Enriched 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

-- R --

rbind	rbind TableTree and related objects
rbind-method	rbind TableTree and related objects
rbind2-method	rbind TableTree and related objects
rbindl_rtables	rbind 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
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	Return List with Table Row/Col Paths
row_paths_summary	Print Row/Col 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	row
rrowl	rrowl
rtable	Create a Table
rtablel	Create a Table
rtables_aligns	Alignment utils

-- S --

select_all_levels	Add Combination Levels to split
sf_args	Split Function Arg 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 Path for 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_rows	summarize_rows
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
top_left	Top Left Material (Experimental)
top_left-method	Top Left Material (Experimental)
top_left<-	Top Left Material (Experimental)
top_left<--method	Top Left Material (Experimental)
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 (Postprocessing 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
trim_zero_rows	Trim Zero Rows
tt_at_path	Get or set table elements at specified path
tt_at_path<-	Get or set table elements at specified path
tt_to_flextable	Create a FlexTable object representing an rtables TableTree

-- U --

update_ref_indexing

Update footnote indexes on a built table

-- V --

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'