Package index • rtables

All functions

CellValue(): Constructor for Cell Value
EmptyColInfo EmptyElTable EmptyRootSplit EmptyAllSplit: Empty table, column, split objects
ManualSplit(): Manually defined split
MultiVarSplit(): Split between two or more different variables
VarLevelSplit() VarLevWBaselineSplit(): Split on levels within a variable
Viewer(): Display an rtable object in the Viewer pane in RStudio or in a browser
add_colcounts(): Add the column population counts to the header
add_combo_facet() add_overall_facet(): Add a combination facet in post-processing
add_existing_table(): Add an already calculated table to the layout
add_overall_col(): Add overall column
add_overall_level() select_all_levels add_combo_levels(): Add overall or combination levels to split groups
additional_fun_params: Additional parameters within analysis and content functions (afun/cfun)
analyze(): Generate rows analyzing variables across columns
analyze_colvars(): Generate rows analyzing different variables across columns
append_topleft(): Append a description to the 'top-left' materials for the layout
as_html(): Convert an rtable object to a shiny.tag HTML object
as.vector(<VTableTree>): Convert to a vector
AnalyzeVarSplit() AnalyzeColVarSplit() AnalyzeMultiVars(): Define a subset tabulation/analysis
basic_table(): Layout with 1 column and zero rows
`[<-`(<VTableTree>,<ANY>,<ANY>,<list>) `[`(<VTableTree>,<logical>,<logical>): Retrieve and assign elements of a TableTree
build_table(): Create a table from a layout and data
cbind_rtables(): Column-bind two TableTree objects
cell_values() value_at(): Retrieve cell values by row and column path
InstantiatedColumnInfo(): Instantiated column info
clear_indent_mods(): Clear all indent modifiers from a table
clayout() `clayout<-`() col_info() `col_info<-`() coltree() col_exprs() col_counts() `col_counts<-`() col_total() `col_total<-`(): Column information/structure accessors
colcount_visible() `colcount_visible<-`(): Value and Visibility of specific column counts by path
collect_leaves(): Collect leaves of a TableTree
coltree_structure(): Display column tree structure
compare_rtables(): Compare two rtables
compat_args(): Compatibility argument conventions
content_table() `content_table<-`(): Retrieve or set content table from a TableTree
counts_wpcts(): Analysis function to count levels of a factor with percentage of the column total
custom_split_funs: Custom split functions
make_static_cut_split() VarDynCutSplit(): Splits for cutting by values of a numeric variable
as_result_df() path_enriched_df(): Generate a result data frame
df_to_tt(): Create an ElementaryTable from a data.frame
nrow(<VTableTree>) ncol(<VTableNodeInfo>) dim(<VTableNodeInfo>): Table dimensions
do_base_split(): Apply basic split (for use in custom split functions)
drop_facet_levels(): Pre-processing function for use in make_split_fun
facet_colcount() `facet_colcount<-`(): Get or set column count for a facet in column space
`facet_colcounts_visible<-`(): Set visibility of column counts for a group of sibling facets
find_degen_struct() experimental: Find degenerate (sub)structures within a table
format_rcell(): Format rcell objects
obj_name(<VNodeInfo>) obj_name(<Split>) `obj_name<-`(<VNodeInfo>) `obj_name<-`(<Split>) obj_label(<Split>) obj_label(<TableRow>) obj_label(<VTableTree>) obj_label(<ValueWrapper>) `obj_label<-`(<Split>) `obj_label<-`(<TableRow>) `obj_label<-`(<ValueWrapper>) `obj_label<-`(<VTableTree>) obj_format(<VTableNodeInfo>) obj_format(<CellValue>) obj_format(<Split>) `obj_format<-`(<VTableNodeInfo>) `obj_format<-`(<Split>) `obj_format<-`(<CellValue>) obj_na_str(<Split>) main_title(<VTitleFooter>) `main_title<-`(<VTitleFooter>) main_title(<TableRow>) subtitles(<VTitleFooter>) `subtitles<-`(<VTitleFooter>) subtitles(<TableRow>) main_footer(<VTitleFooter>) `main_footer<-`(<VTitleFooter>) main_footer(<TableRow>) prov_footer(<VTitleFooter>) `prov_footer<-`(<VTitleFooter>) prov_footer(<TableRow>) table_inset(<VTableNodeInfo>) table_inset(<PreDataTableLayouts>) `table_inset<-`(<VTableNodeInfo>) `table_inset<-`(<PreDataTableLayouts>) `table_inset<-`(<InstantiatedColumnInfo>) obj_round_type(<ANY>) obj_round_type(<PreDataTableLayouts>) obj_round_type(<VTableTree>) obj_round_type(<TableRow>) obj_round_type(<CellValue>) `obj_round_type<-`(<VTableTree>) `obj_round_type<-`(<TableRow>) `obj_round_type<-`(<LabelRow>) `obj_round_type<-`(<CellValue>) nlines(<TableRow>) nlines(<LabelRow>) nlines(<RefFootnote>) nlines(<InstantiatedColumnInfo>) make_row_df(<VTableTree>) make_row_df(<TableRow>) make_row_df(<LabelRow>): Methods for generics in the formatters package
get_formatted_cells() get_cell_aligns(): Get formatted cells
head() tail(): Head and tail methods
horizontal_sep() `horizontal_sep<-`(): Access or recursively set header-body separator for tables
in_rows(): Create multiple rows in analysis or summary functions
indent(): Change indentation of all rrows in an rtable
indent_string(): Indent strings
insert_row_at_path(): Insert row at path
insert_rrow() deprecated: Insert rrows at (before) a specific location
is_rtable(): Check if an object is a valid rtable
label_at_path() `label_at_path<-`(): Label at path
length(<CellValue>): Length of a Cell value
list_wrap_x() list_wrap_df(): Returns a function that coerces the return values of a function to a list
make_afun(): Create a custom analysis function wrapping an existing function
make_col_df(): Column layout summary
row_paths() col_paths(): Get a list of table row/column paths
make_split_fun(): Create a custom splitting function
make_split_result() add_to_split_result(): Construct split result object
make_subset_expr(): Make subset expression for a split-value pair
manual_cols(): Manual column declaration
matrix_form(<VTableTree>): Transform an rtable to a list of matrices which can be used for outputting
names(<VTableNodeInfo>) names(<InstantiatedColumnInfo>) names(<LayoutColTree>) row.names(<VTableTree>): Names of a TableTree
no_colinfo(): Exported for use in tern
pag_tt_indices() paginate_table(): Pagination of a TableTree
prune_table(): Recursively prune a TableTree
qtable_layout() qtable(): Generalized frequency table
rbindl_rtables() rbind(<VTableNodeInfo>) rbind2(<VTableNodeInfo>,<ANY>): Row-bind TableTree and related objects
rcell() non_ref_rcell(): Cell value constructors
row_footnotes() `row_footnotes<-`() cell_footnotes() `cell_footnotes<-`() col_fnotes_here() `col_fnotes_here<-`() col_footnotes() `col_footnotes<-`() ref_index() `ref_index<-`() ref_symbol() `ref_symbol<-`() ref_msg() `fnotes_at_path<-`(): Referential footnote accessors
restrict_facets(): Postprocessing split function behavior to generally restrict facets
rheader(): Create a header
rm_all_colcounts(): Set all column counts at all levels of nesting to NA
obj_avar() row_cells() `row_cells<-`() row_values() `row_values<-`(): Row attribute accessors
row_paths_summary() col_paths_summary(): Print row/column paths summary
LabelRow() .tablerow() DataRow() ContentRow(): Row classes and constructors
rrow(): Create an rtable row
rrowl(): Create an rtable row from a vector or list of values
rtable() rtablel(): Create a table
simple_analysis(): Default tabulation
sanitize_table_struct() experimental: Sanitize degenerate table structures
cont_n_allcols() cont_n_onecol(): Score functions for sorting TableTrees
section_div() `section_div<-`() header_section_div() `header_section_div<-`() top_level_section_div() `top_level_section_div<-`() section_div_info() section_div_at_path() `section_div_at_path<-`(): Section dividers accessor and setter
sf_args(): Split function argument conventions
sort_at_path(): Sorting a table at a specific path
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
split_cols_by(): Declaring a column-split based on levels of a variable
split_cols_by_multivar(): Associate multiple variables with columns
keep_split_levels() remove_split_levels() drop_split_levels() drop_and_remove_levels() reorder_split_levels() trim_levels_in_group(): Split functions
split_rows_by(): Add rows according to levels of a variable
split_rows_by_multivar(): Associate multiple variables with rows
subset_cols(): Subset a table or row to particular columns
summarize_row_groups(): Add a content row of summary counts
ElementaryTable() TableTree(): TableTree classes
table_shell() table_shell_str(): Table shells
table_structure(): Summarize table
top_left() `top_left<-`(): Top left material
toString(<VTableTree>): Convert an rtable object to a string
tree_children() `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_to_map(): Trim levels to map
all_zero_or_na() all_zero() content_all_zeros_nas() prune_empty_level() prune_zeros_only() low_obs_pruner(): Trimming and pruning criteria
trim_rows(): Trim rows from a populated table without regard for table structure
export_as_tsv() import_from_tsv(): Create enriched flat value table with paths
tt_row_path_exists() tt_normalize_row_path(): Pathing
tt_at_path() `tt_at_path<-`(): Access or set table elements at specified path
update_ref_indexing(): Update footnote indices on a built table
validate_table_struct() assert_valid_table() experimental: Validate and assert valid table structure
value_formats(): Value formats
split_cols_by_cuts() split_rows_by_cuts() split_cols_by_cutfun() split_cols_by_quartiles() split_rows_by_quartiles() split_rows_by_cutfun(): Split on static or dynamic cuts of the data
vars_in_layout(): List variables required by a pre-data table layout