num_row: Numeric Row

In thomasgstewart/tangram.pipe: Row-by-Row Table Building

Numeric Row

Description

Adds in a numeric row to a tangram.pipe table.

Usage

num_row(
  list_obj,
  row_var,
  col_var = NULL,
  newdata = FALSE,
  rowlabel = NULL,
  summary = NULL,
  missing = NULL,
  overall = NULL,
  comparison = NULL,
  digits = NULL
)

Arguments

list_obj	the name of the tbl_start object previously initialized.
row_var	the name of the variable to be used in the rows.
col_var	the variable to be used in the table columns. Default is from initialized tbl_start object.
newdata	enter new dataset name if different from that initialized in tbl_start.
rowlabel	the label for the table row name, if different from row_var.
summary	summary function for the data, if different from the one supplied in tbl_start.
missing	logical: if TRUE, missing data is considered; FALSE only uses complete cases.
overall	logical: if TRUE, an overall column is included.
comparison	the name of the comparison test to use, if different from that initialized in tbl_start.
digits	significant digits to use.

Value

A list with the numeric row's table information added as a new element to list_obj.

See Also

Possible summary functions for numeric data: num_default, num_mean_sd, num_medianiqr, num_minmax, num_date

Other related row-building functions: cat_row, binary_row, n_row, empty_row

Starting a tangram.pipe table: tbl_start

Examples

x <- tbl_start(iris, "Species", missing=TRUE, overall=TRUE, comparison=TRUE) %>%
  num_row("Sepal.Length", rowlabel="Sepal Length")

thomasgstewart/tangram.pipe documentation built on Aug. 18, 2022, 8:41 p.m.