rtables0.6.11 package

Reporting Tables

add_colcounts

Add the column population counts to the header

add_combo_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

Add overall or combination levels to split groups

additional_fun_params

Additional parameters within analysis and content functions (afun/`c...

analyze_colvars

Generate rows analyzing different variables across columns

analyze

Generate rows analyzing 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

asvec

Convert to a vector

avarspl

Define a subset tabulation/analysis

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

cbind_rtables

Column-bind two TableTree objects

cell_values

Retrieve cell values by row and column path

CellValue

Constructor for Cell Value

cinfo

Instantiated column info

clear_imods

Clear all indent modifiers from a table

col_accessors

Column information/structure accessors

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

constr_args

Constructor argument conventions

content_table

Retrieve or set content table from a TableTree

counts_wpcts

Analysis function to count levels of a factor with percentage of the c...

custom_split_funs

Custom split functions

cutsplits

Splits for cutting by values of a numeric variable

data.frame_export

Generate a result data frame

df_to_tt

Create an ElementaryTable from a data.frame

dimensions

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

EmptyColInfo

Empty table, column, split objects

facet_colcount

Get or set column count for a facet in column space

facet_colcounts_visible-set

Set visibility of column counts for a group of sibling facets

find_degen_struct

Find degenerate (sub)structures within a table

format_rcell

Format rcell objects

formatters_methods

Methods for generics in the formatters package

gen_args

General argument conventions

gfc

Get formatted cells

head_tail

Head and tail methods

horizontal_sep

Access or recursively set header-body separator for tables

in_rows

Create multiple rows in analysis or summary functions

indent_string

Indent strings

indent

Change indentation of all rrows in an rtable

insert_row_at_path

Insert row at path

insert_rrow

Insert rrows at (before) a specific location

int_methods

Combine SplitVector objects

is_rtable

Check if an object is a valid rtable

label_at_path

Label at path

length-CellValue-method

Length of a Cell value

list_wrap

Returns a function that coerces the return values of a function to a l...

lyt_args

Layouting function argument conventions

make_afun

Create a custom analysis function wrapping an existing function

make_col_df

Column layout summary

make_col_row_df

Get a list of table row/column paths

make_split_fun

Create a custom splitting function

make_split_result

Construct split result object

manual_cols

Manual column declaration

ManualSplit

Manually defined split

matrix_form-VTableTree-method

Transform an rtable to a list of matrices which can be used for outp...

MultiVarSplit

Split between two or more different variables

names

Names of a TableTree

no_info

Exported for use in tern

paginate

Pagination of a TableTree

prune_table

Recursively prune a TableTree

qtable_layout

Generalized frequency table

rbind

Row-bind TableTree and related objects

rcell

Cell value constructors

reexports

Objects exported from other packages

ref_fnotes

Referential footnote accessors

rheader

Create a header

rm_all_colcounts

Set all column counts at all levels of nesting to NA

row_accessors

Row attribute accessors

row_paths_summary

Print row/column paths summary

rowclasses

Row classes and constructors

rrow

Create an rtable row

rrowl

Create an rtable row from a vector or list of values

rtable

Create a table

rtables-package

rtables: Reporting Tables

rtinner

Default tabulation

sanitize_table_struct

Sanitize degenerate table structures

score_funs

Score functions for sorting TableTrees

section_div

Section dividers accessor and setter

sf_args

Split function argument conventions

sort_at_path

Sorting a table at a specific path

spl_context_to_disp_path

Translate spl_context to a path to display in error messages

spl_context

.spl_context within analysis and split functions

spl_variable

Variable associated with a split

split_cols_by_multivar

Associate multiple variables with columns

split_cols_by

Declaring a column-split based on levels of a variable

split_funcs

Split functions

split_rows_by_multivar

Associate multiple variables with rows

split_rows_by

Add rows according to levels of a variable

summarize_row_groups

Add a content row of summary counts

tabclasses

TableTree classes

table_shell

Table shells

table_structure

Summarize table

top_left

Top left material

tostring

Convert an rtable object to a string

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...

trim_levels_to_map

Trim levels to map

trim_prune_funs

Trimming and pruning criteria

trim_rows

Trim rows from a populated table without regard for table structure

tsv_io

Create enriched flat value table with paths

ttap

Access or set table elements at specified path

update_ref_indexing

Update footnote indices on a built table

validate_table_struct

Validate and assert valid table structure

value_formats

Value formats

varcuts

Split on static or dynamic cuts of the data

VarLevelSplit

Split on levels within a variable

Viewer

Display an rtable object in the Viewer pane in RStudio or in a brows...

vil

List variables required by a pre-data table layout

Reporting tables often have structure that goes beyond simple rectangular data. The 'rtables' package provides a framework for declaring complex multi-level tabulations and then applying them to data. This framework models both tabulation and the resulting tables as hierarchical, tree-like objects which support sibling sub-tables, arbitrary splitting or grouping of data in row and column dimensions, cells containing multiple values, and the concept of contextual summary computations. A convenient pipe-able interface is provided for declaring table layouts and the corresponding computations, and then applying them to data.

  • Maintainer: Joe Zhu
  • License: Apache License 2.0 | file LICENSE
  • Last published: 2025-01-10