Reporting Tables


[Up] [Top]

Documentation for package ‘rtables’ version 0.6.0

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
analysis_fun combine SplitVector objects
analysis_fun-method combine SplitVector objects
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
as.vector-method combine SplitVector objects
asvec convert to a vector
as_html Convert an 'rtable' object to a 'shiny.tag' html object
avar_inclNAs combine SplitVector objects
avar_inclNAs-method combine SplitVector objects
avar_inclNAs<- combine SplitVector objects
avar_inclNAs<--method combine SplitVector objects

-- B --

basic_table Layout with 1 column and zero rows
build_table Create a table from a layout and data

-- C --

c-method combine SplitVector objects
cbind_rtables cbind two rtables
CellValue Cell Value constructor
cell_align combine SplitVector objects
cell_align-method combine SplitVector objects
cell_align<- combine SplitVector objects
cell_align<--method combine SplitVector objects
cell_cspan combine SplitVector objects
cell_cspan-method combine SplitVector objects
cell_cspan<- combine SplitVector objects
cell_cspan<--method combine SplitVector objects
cell_footnotes Referential Footnote Accessors
cell_footnotes-method combine SplitVector objects
cell_footnotes<- Referential Footnote Accessors
cell_footnotes<--method combine SplitVector objects
cell_values Retrieve cell values by row and column path
cell_values-method 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
cmpnd_last_rowsplit combine SplitVector objects
cmpnd_last_rowsplit-method combine SplitVector objects
colcount_format combine SplitVector objects
colcount_format-method combine SplitVector objects
colcount_format<- combine SplitVector objects
colcount_format<--method combine SplitVector objects
collect_leaves Collect leaves of a table tree
collect_leaves-method combine SplitVector objects
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_extra_args combine SplitVector objects
col_extra_args-method combine SplitVector objects
col_fnotes_here Referential Footnote Accessors
col_fnotes_here-method combine SplitVector objects
col_fnotes_here<- Referential Footnote Accessors
col_fnotes_here<--method combine SplitVector objects
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_extra_args combine SplitVector objects
content_extra_args-method combine SplitVector objects
content_extra_args<- combine SplitVector objects
content_extra_args<--method combine SplitVector objects
content_format combine SplitVector objects
content_format-method combine SplitVector objects
content_format<- combine SplitVector objects
content_format<--method combine SplitVector objects
content_fun combine SplitVector objects
content_fun-method combine SplitVector objects
content_fun<- combine SplitVector objects
content_fun<--method combine SplitVector objects
content_indent_mod combine SplitVector objects
content_indent_mod-method combine SplitVector objects
content_indent_mod<- combine SplitVector objects
content_indent_mod<--method combine SplitVector objects
content_na_str combine SplitVector objects
content_na_str-method combine SplitVector objects
content_na_str<- combine SplitVector objects
content_na_str<--method combine SplitVector objects
content_table Retrieve or set Content Table from a TableTree
content_table-method combine SplitVector objects
content_table<- Retrieve or set Content Table from a TableTree
content_table<--method combine SplitVector objects
content_var combine SplitVector objects
content_var-method combine SplitVector objects
content_var<- combine SplitVector objects
content_var<--method combine SplitVector objects
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
disp_ccounts combine SplitVector objects
disp_ccounts-method combine SplitVector objects
disp_ccounts<- combine SplitVector objects
disp_ccounts<--method combine SplitVector objects
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_rtf Export table to RTF
export_as_tsv Create Enriched flat value table with paths
export_as_txt Export as plain text with page break symbol

-- F --

fix_dyncuts combine SplitVector objects
fix_dyncuts-method combine SplitVector objects
fnotes_at_path<- Referential Footnote Accessors
fnotes_at_path<--method combine SplitVector objects
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_mod combine SplitVector objects
indent_mod-method combine SplitVector objects
indent_mod<- combine SplitVector objects
indent_mod<--method combine SplitVector objects
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
internal_methods combine SplitVector objects
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
labelrow_visible combine SplitVector objects
labelrow_visible-method combine SplitVector objects
labelrow_visible<- combine SplitVector objects
labelrow_visible<--method combine SplitVector objects
label_at_path Label at Path
label_at_path<- Label at Path
label_kids combine SplitVector objects
label_kids-method combine SplitVector objects
label_kids<- combine SplitVector objects
label_kids<--method combine SplitVector objects
label_position combine SplitVector objects
label_position-method combine SplitVector objects
label_position<- combine SplitVector objects
label_position<--method combine SplitVector objects
last_rowsplit combine SplitVector objects
last_rowsplit-method combine SplitVector objects
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
ncol-method combine SplitVector objects
next_cpos combine SplitVector objects
next_cpos-method combine SplitVector objects
next_rpos combine SplitVector objects
next_rpos-method combine SplitVector objects
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
nrow-method combine SplitVector objects

-- 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
obj_na_str-method combine SplitVector objects
obj_na_str<--method combine SplitVector objects

-- 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
pos_splits combine SplitVector objects
pos_splits-method combine SplitVector objects
pos_splvals combine SplitVector objects
pos_splvals-method combine SplitVector objects
pos_splval_labels combine SplitVector objects
pos_splval_labels-method combine SplitVector objects
pos_subset combine SplitVector objects
pos_subset-method combine SplitVector objects
print-method combine SplitVector objects
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 --

rawvalues combine SplitVector objects
rawvalues-method combine SplitVector objects
rbind rbind TableTree and related objects
rbind-method rbind TableTree and related objects
rbind2-method combine SplitVector 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-method combine SplitVector objects
ref_index<- Referential Footnote Accessors
ref_index<--method combine SplitVector objects
ref_msg Referential Footnote Accessors
ref_msg-method combine SplitVector objects
remove_split_levels Split functions
reorder_split_levels Split functions
rheader Create a header
rlayout combine SplitVector objects
rlayout-method combine SplitVector objects
rlayout<- combine SplitVector objects
rlayout<--method combine SplitVector objects
root_spl combine SplitVector objects
root_spl-method combine SplitVector objects
root_spl<- combine SplitVector objects
root_spl<--method combine SplitVector objects
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_cspans combine SplitVector objects
row_cspans-method combine SplitVector objects
row_cspans<- combine SplitVector objects
row_cspans<--method combine SplitVector objects
row_footnotes Referential Footnote Accessors
row_footnotes-method combine SplitVector objects
row_footnotes<- Referential Footnote Accessors
row_footnotes<--method combine SplitVector objects
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
set_format_recursive combine SplitVector objects
set_format_recursive-method combine SplitVector objects
sf_args Split Function Arg Conventions
show-method combine SplitVector objects
simple_analysis Default tabulation
simple_analysis-method Default tabulation
sort_at_path Sort substructure of a TableTree at a particular Path in the Tree.
spanned_cells combine SplitVector objects
spanned_cells-method combine SplitVector objects
spanned_values combine SplitVector objects
spanned_values-method combine SplitVector objects
spanned_values<- combine SplitVector objects
spanned_values<--method combine SplitVector objects
split_cols combine SplitVector objects
split_cols-method combine SplitVector objects
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_exargs combine SplitVector objects
split_exargs-method combine SplitVector objects
split_exargs<- combine SplitVector objects
split_exargs<--method combine SplitVector objects
split_fun combine SplitVector objects
split_fun-method combine SplitVector objects
split_fun<- combine SplitVector objects
split_fun<--method combine SplitVector objects
split_funcs Split functions
split_rows combine SplitVector objects
split_rows-method combine SplitVector objects
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_quartiles Split on static or dynamic cuts of the data
splv_extra combine SplitVector objects
splv_extra-method combine SplitVector objects
splv_extra<- combine SplitVector objects
splv_extra<--method combine SplitVector objects
spl_child_order combine SplitVector objects
spl_child_order-method combine SplitVector objects
spl_child_order<- combine SplitVector objects
spl_child_order<--method combine SplitVector objects
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_cutfun combine SplitVector objects
spl_cutfun-method combine SplitVector objects
spl_cutlabelfun combine SplitVector objects
spl_cutlabelfun-method combine SplitVector objects
spl_cutlabels combine SplitVector objects
spl_cutlabels-method combine SplitVector objects
spl_cuts combine SplitVector objects
spl_cuts-method combine SplitVector objects
spl_is_cmlcuts combine SplitVector objects
spl_is_cmlcuts-method combine SplitVector objects
spl_labelvar combine SplitVector objects
spl_labelvar-method combine SplitVector objects
spl_label_var combine SplitVector objects
spl_label_var-method combine SplitVector objects
spl_payload combine SplitVector objects
spl_payload-method combine SplitVector objects
spl_payload<- combine SplitVector objects
spl_payload<--method combine SplitVector objects
spl_variable Variable Associated With a Split
spl_variable-method Variable Associated With a Split
spl_varlabels combine SplitVector objects
spl_varlabels-method combine SplitVector objects
spl_varlabels<- combine SplitVector objects
spl_varlabels<--method combine SplitVector objects
spl_varnames combine SplitVector objects
spl_varnames-method combine SplitVector objects
spl_varnames<- combine SplitVector objects
spl_varnames<--method combine SplitVector objects
str-method combine SplitVector objects
subtitles-method Methods for generics in the formatters package
subtitles<--method Methods for generics in the formatters package
summarize_rows summarize_rows
summarize_rows_inner combine SplitVector objects
summarize_rows_inner-method combine SplitVector objects
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
table_structure_inner combine SplitVector objects
table_structure_inner-method combine SplitVector objects
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-method combine SplitVector objects
tree_children<- Retrieve or set the direct children of a Tree-style object
tree_children<--method combine SplitVector objects
tree_pos combine SplitVector objects
tree_pos-method combine SplitVector objects
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-method combine SplitVector objects
tt_at_path<- Get or set table elements at specified path
tt_at_path<--method combine SplitVector objects
tt_labelrow combine SplitVector objects
tt_labelrow-method combine SplitVector objects
tt_labelrow<- combine SplitVector objects
tt_labelrow<--method combine SplitVector objects
tt_level combine SplitVector objects
tt_level-method combine SplitVector objects
tt_level<- combine SplitVector objects
tt_level<--method combine SplitVector objects
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
value_labels combine SplitVector objects
value_labels-method combine SplitVector objects
value_names combine SplitVector objects
value_names-method combine SplitVector objects
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
vis_label combine SplitVector objects
vis_label-method combine SplitVector objects

-- misc --

.add_row_summary combine SplitVector objects
.add_row_summary-method combine SplitVector objects
.tablerow Row classes and constructors