# The Grammar of Tables

## Documentation for package ‘tangram’ version 0.4

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A C D F H I K L N P R S T W misc

## -- A --

add_col | Table Construction Toolset
add_indent | Add indentations to left column row headers
add_row | Table Construction Toolset
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 | Table Construction Toolset
cbind.tangram | A cbind for generated table tangram objects.
cell | Construct a table cell from an object
cell.aov | AOV model as cell
cell.htest | Construct hypothesis test cell
cell_chi2 | Create an cell_chi2 (S3) object of the given statistic
cell_estimate | Create a cell_estimate object of the given estimate
cell_fraction | Create an cell_fraction (S3) object of the given statistic
cell_fstat | Create an cell_fstat (S3) object of the given statistic
cell_header | Create a cell_header object of the given text.
cell_iqr | Create a interquartile range cell object of the given data
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_named_values | Create named value cells
cell_range | Create a cell representing a range
cell_spearman | Create an cell_spearman (S3) object of the given statistic
cell_studentt | Create an cell_studentt (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
cols.table_builder | S3 object to return number of rows/cols in object
col_header | Table Construction Toolset
csv | Generate an csv from a tangram or cell object
csv.cell_chi2 | Generate an csv from a tangram or cell object
csv.cell_fstat | Generate an csv from a tangram or cell object
csv.cell_header | Generate an csv from a tangram or cell object
csv.cell_studentt | Generate an csv from a tangram or cell object
csv.cell_subheader | Generate an csv from a tangram or cell object
csv.default | Generate an csv from a tangram or cell object
csv.table_builder | Generate an csv from a tangram or cell object
csv.tangram | Generate an csv from a tangram or cell object
cursor_down | Table Construction Toolset
cursor_left | Table Construction Toolset
cursor_pos | Table Construction Toolset
cursor_right | Table Construction Toolset
cursor_up | Table Construction Toolset
custom_css | Return a CSS file as a string

## -- D --

del_col | Delete a given column from a table
del_row | Delete a given row 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_data_type | Determine data type of a vector loosely consistent with Hmisc.
hmisc_intercept_cleanup | Cleanup an intercept only model
hmisc_style | Style Bundle for Hmisc defaults.
home | Table Construction Toolset
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_chi2 | Convert an abstract cell_chi2 object into an HTML5 string
html5.cell_estimate | Convert a cell_estimate object into an HTML5 string
html5.cell_fraction | Convert an abstract cell_fraction object into an HTML5 string
html5.cell_fstat | Convert a cell_fstat object into an HTML5 string
html5.cell_header | Convert an abstract cell_header object into an HTML5 string
html5.cell_iqr | Convert a cell_iqr 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.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_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 --

latex | Render to LaTeX methods for tangram cell objects
latex.cell | Render to LaTeX methods for tangram cell objects
latex.cell_chi2 | Render to LaTeX methods for tangram cell objects
latex.cell_estimate | Render to LaTeX methods for tangram cell objects
latex.cell_fraction | Render to LaTeX methods for tangram cell objects
latex.cell_fstat | Render to LaTeX methods for tangram cell objects
latex.cell_header | Render to LaTeX methods for tangram cell objects
latex.cell_iqr | Render to LaTeX methods for tangram cell objects
latex.cell_label | Render to LaTeX methods for tangram cell objects
latex.cell_n | Render to LaTeX methods for tangram cell objects
latex.cell_spearman | Render to LaTeX methods for tangram cell objects
latex.cell_studentt | 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.tangram | Render to LaTeX methods for tangram cell objects
line_feed | Table Construction Toolset

## -- N --

nejm_style | Style Bundle for Closer to NEJM style
new_col | Table Construction Toolset
new_line | Table Construction Toolset
new_row | Table Construction Toolset

## -- 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.table_builder | Print a text summary of a given table_builder
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
rmd | Generate an Rmd table entry from a cell object
rmd.cell | Generate an Rmd table entry from a cell object
rmd.cell_chi2 | Generate an Rmd table entry from a cell object
rmd.cell_estimate | Generate an Rmd table entry from a cell object
rmd.cell_fraction | Generate an Rmd table entry from a cell object
rmd.cell_fstat | Generate an Rmd table entry from a cell object
rmd.cell_iqr | Generate an Rmd table entry from a cell object
rmd.cell_n | Generate an Rmd table entry from a cell object
rmd.cell_spearman | Generate an Rmd table entry from a cell object
rmd.cell_studentt | Generate an Rmd table entry from a cell object
rmd.default | Generate an Rmd table entry from a cell object
rmd.table_builder | 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
rows.table_builder | S3 object to return number of rows/cols in object
row_header | Table Construction Toolset
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 --

summarize_chisq | Create a summarization for a categorical row versus a categorical column
summarize_kruskal_horz | Create a summarization for a categorical set of column versus a numerical row
summarize_kruskal_vert | Create a summarization for a categorical row versus a numerical column
summarize_nejm_horz | Create a summarization for a categorical set of column versus a numerical row in NEJM style
summarize_spearman | Create a summarization for a numerical row versus a numerical column
summary.cell | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_chi2 | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_estimate | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_fraction | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_fstat | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_iqr | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_label | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_range | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_spearman | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.cell_studentt | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.table_builder | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.
summary.tangram | The default method for rendering tangram objects A tangram is a summary, so it returns itself. Otherwise convert to a text representation.

## -- T --

table_builder | Table Construction Toolset
table_builder_apply | Table Construction Toolset
table_flatten | Given a tangram object with embedded tables, flattens to a single table.
tangram | Table creation methods
tangram.character | Table creation methods
tangram.data.frame | Table creation methods
tangram.formula | Table creation methods
tangram.numeric | Table creation methods
tangram.rms | Table creation methods
tangram.table | Table creation methods
tangram.tbl_df | Table creation methods
Token | A token in the formula grammar

## -- W --

write_cell | Table Construction Toolset

## -- misc --

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