The Grammar of Tables

Documentation for package ‘tangram’ version 0.8.2

DESCRIPTION file.

Help Pages

-- A --

add_col	A set of magrittr operators for tangram tables
add_footnote	Add a footnote to a table
add_indent	Add indentations to left column row headers
add_row	A set of magrittr operators for tangram tables
args_flatten	Flatten variable arguments
as.categorical	Convert data type to a factor if it's not already
ASTBranch	A left/right branch in an Abstract Syntrax Tree. This inherits from ASTNode, and is intended to be a base class as well. Should never be instantiated directly as once again the semantic information is contained in the class name.
ASTFunction	A specified function call as an ASTNode
ASTMultiply	The multiplication of two terms, as an ASTNode.
ASTNode	A Node in an Abstract Syntax Tree (AST)
ASTPlus	The addition of two terms, in an ASTNode.
ASTTableFormula	The root ASTNode of a formula.
ASTVariable	A Variable in an Abstract Syntax Tree (AST)

-- C --

carriage_return	A set of magrittr operators for tangram tables
cbind.tangram	A cbind for generated table tangram objects.
cell	Construct a table cell from an object
cell_header	Create a cell_header object of the given text.
cell_label	Create an cell_label (S3) object of the given text.
cell_n	Create an cell_n (S3) object of the given statistic
cell_subheader	Create a cell_subheader object of the given text.
cell_transform	Create a function to transform all cells of a table
cols	S3 object to return number of rows/cols in object
cols.list	S3 object to return number of rows/cols in object
col_header	A set of magrittr operators for tangram tables
csv	Generate an csv from a tangram or cell object
csv.default	Generate an csv from a tangram or cell object
csv.tangram	Generate an csv from a tangram or cell object
cursor_down	A set of magrittr operators for tangram tables
cursor_left	A set of magrittr operators for tangram tables
cursor_pos	A set of magrittr operators for tangram tables
cursor_right	A set of magrittr operators for tangram tables
cursor_up	A set of magrittr operators for tangram tables
custom_css	Return a CSS file as a string

-- D --

del_col	Delete given column(s) from a table
del_row	Delete a row(s) from a table
derive_label	Derive label of AST node.
drop_statistics	Drop all statistics columns from a table.

-- F --

format_guess

Guess the best format for a given set of numerical data

-- H --

hmisc	Style Bundle for Hmisc defaults
hmisc_cell	Cell Generation functions for hmisc default
hmisc_chi2	Cell Generation functions for hmisc default
hmisc_data_type	Determine data type of a vector loosely consistent with Hmisc.
hmisc_fraction	Cell Generation functions for hmisc default
hmisc_fstat	Cell Generation functions for hmisc default
hmisc_intercept_cleanup	Cleanup an intercept only model
hmisc_iqr	Cell Generation functions for hmisc default
hmisc_p	Cell Generation functions for hmisc default
hmisc_spearman	Cell Generation functions for hmisc default
hmisc_wilcox	Cell Generation functions for hmisc default
home	A set of magrittr operators for tangram tables
html5	S3 html5 Method function for use on a tangram to generate HTML5
html5.cell	Convert an abstract cell object into an HTML5 string
html5.cell_header	Convert an abstract cell_header object into an HTML5 string
html5.cell_label	Convert a cell_label object into an HTML5 string
html5.cell_n	Convert an abstract cell_n object into an HTML5 string
html5.cell_subheader	Convert an abstract cell_subheader object into an HTML5 string
html5.character	Default conversion to HTML5 for a character cell
html5.default	Default conversion to HTML5 for an abstract table element
html5.logical	Default conversion to HTML5 for a logical cell
html5.tangram	Convert a tangram class into an HTML5 string

-- I --

index	Generate an index from a tangram or cell object
index.cell_label	Generate an index from a label object
index.default	Generate an index from a cell object
index.list	Generate an index from a list object
index.tangram	Generate an an index from a tangram object
insert_column	Insert a column into a tangram table
insert_row	Insert a row into a tangram table
is.binomial	Determine if a vector is binomial or not
is.categorical	Determine if a vector is categorical or not

-- K --

key	Key derivation helper function

-- L --

lancet	Style Bundle for Lancet style
lancet_cell	Cell Generation functions for Lancet styling
lancet_fraction	Create an cell_fraction (S3) in NEJM style of the given data
lancet_mean_sd	Create a mean/sd cell object of the given data in Lancet style
latex	Render to LaTeX methods for tangram cell objects
latex.cell	Render to LaTeX methods for tangram cell objects
latex.cell_header	Render to LaTeX methods for tangram cell objects
latex.cell_label	Render to LaTeX methods for tangram cell objects
latex.cell_subheader	Render to LaTeX methods for tangram cell objects
latex.default	Render to LaTeX methods for tangram cell objects
latex.logical	Render to LaTeX methods for tangram cell objects
latex.tangram	Render to LaTeX methods for tangram cell objects
latexify	LaTeX safe string conversion
latex_template	Return a LaTeX template that works with tangram
line_feed	A set of magrittr operators for tangram tables

-- N --

nejm	Style Bundle for Closer to NEJM style
nejm_cell	Cell Generation functions for nejm default
nejm_fraction	Create an cell_fraction (S3) in NEJM style of the given data
nejm_iqr	Create a interquartile range cell object of the given data NEJM style
nejm_range	Create a NEJM style range
new_col	A set of magrittr operators for tangram tables
new_line	A set of magrittr operators for tangram tables
new_row	A set of magrittr operators for tangram tables

-- P --

Parser	The parser class for generating abstract syntax trees for given table formulas.
pbc	Mayo Clinic Primary Biliary Cirrhosis Data
pipe.tangram	Provide a "\|" operator for cbind of tangram tables
print.cell	Print methods for tangram objects
print.summary.tangram	Print methods for tangram objects
print.tangram	Print methods for tangram objects
proc_tab	Tangram transform for proc_tab style summaries via a function

-- R --

rbind.tangram	An rbind for generated tables tangram objects.
render_f	Format a vector of provided numeric values
render_route_tangram	Router for rendering method
replace_cell	Replace a cell's contents
rmd	Generate an Rmd table entry from a cell object
rmd.cell	Generate an Rmd table entry from a cell object
rmd.cell_n	Generate an Rmd table entry from a cell object
rmd.default	Generate an Rmd table entry from a cell object
rmd.tangram	Generate an Rmd table entry from a cell object
rows	S3 object to return number of rows/cols in object
rows.list	S3 object to return number of rows/cols in object
row_header	A set of magrittr operators for tangram tables
rtf	S3 rtf Method function for use on abstract table class
rtf.cell	Given a cell class create an RTF representation.
rtf.cell_chi2	Convert an abstract cell_chi2 object into an rtf string
rtf.cell_fstat	Convert an abstract cell_fstat object into an RTF string
rtf.cell_header	Convert an abstract cell_header object into an RTF string
rtf.cell_iqr	Convert an abstract cell_iqr object into an RTF string
rtf.cell_label	Given a cell_label class create an RTF representation.
rtf.cell_n	Convert an abstract cell_n object into an RTF string
rtf.cell_subheader	Convert an abstract cell_subheader object into an RTF string
rtf.default	Default conversion to RTF for an abstract table element
rtf.tangram	Convert a tangram into an RTF string or file

-- S --

select_col	Select given column(s) from a table
select_row	Select given row(s) from a table
set_caption	A set of magrittr operators for tangram tables
set_colspan	A set of magrittr operators for tangram tables
set_footnote	A set of magrittr operators for tangram tables
set_id	A set of magrittr operators for tangram tables
set_rowspan	A set of magrittr operators for tangram tables
set_style	A set of magrittr operators for tangram tables
smd	List of lists, should contain a "Type" entry with a function to determine type of vector passed in. Next entries are keyed off returned types from function, and represent the type of a row. The returned list should contain the same list of types, and represents the type of a column. Thus it now returns a function to process the intersection of those two types.
smd_cell	Cell Generation functions for SMD comparisons of categorical to numerical
smd_compare	Create a SMD for a categorical set of column versus a numerical row
smd_contingency	Create a contingency table with SMD given a row column of a formula
smd_dist	Create an SMD distance cell
smd_fraction	Create a fraction cell in the smd transform
smd_meansd	Create an SMD mean and standard deviation cell
standard_difference	Compute the standardized mean distance between 2 groups for numerical or categorical information. Using method described in 'A unifed approach to measuring the effect size between two groups using SAS' by Dongsheng Yand and Jarrod E. Dalton, 2012. SAS Global Forum 2012
summarize_chisq	Style Bundle for Hmisc defaults
summarize_kruskal_horz	Style Bundle for Hmisc defaults
summarize_kruskal_vert	Style Bundle for Hmisc defaults
summarize_nejm_horz	Create a summarization for a categorical set of column versus a numerical row in NEJM style
summarize_nejm_vert	Create a summarization for a categorical row versus X numerical column
summarize_spearman	Style Bundle for Hmisc defaults
summary.cell	The default method for rendering tangram objects
summary.tangram	The default method for rendering tangram objects

-- T --

table_apply	A set of magrittr operators for tangram tables
table_flatten	Given a tangram object with embedded tables, flattens to a single table.
tangram	Table creation methods
tangram.anova.lme	Table creation methods
tangram.character	Table creation methods
tangram.clmm2	Table creation methods
tangram.data.frame	Table creation methods
tangram.formula	Table creation methods
tangram.ftable	Table creation methods
tangram.lm	Table creation methods
tangram.matrix	Table creation methods
tangram.numeric	Table creation methods
tangram.rms	Table creation methods
tangram.summary.clmm2	Table creation methods
tangram.summary.lm	Table creation methods
tangram.table	Table creation methods
tangram.tbl_df	Table creation methods
Token	A token in the formula grammar

-- W --

write_cell

A set of magrittr operators for tangram tables

-- misc --

+.tangram	Provide a "+" operator for rbind of tangram tables
\|.tangram	Provide a "\|" operator for cbind of tangram tables