first_table_options: First Table options

In NikNakk/firsttable: Generates a Table in the Style of Table One from a Medical Paper

First Table options

Description

First Table options

Usage

first_table_options(
  template = NULL,
  digits = 1,
  include_p = TRUE,
  p_digits = 3,
  small_p_format = c("<", "E", "x10", "html"),
  small_p_cutoff = NULL,
  include_n = FALSE,
  include_n_per_col = c("no", "row", "embed"),
  workspace = 2e+05,
  default_non_parametric = TRUE,
  na_text = "NA",
  pretty_p = TRUE,
  p_sig_fig = FALSE,
  p_n_sig_fig = 2,
  escape_name = TRUE,
  hide_single_level = FALSE,
  cor_method = c("pearson", "kendall", "spearman"),
  digits_percent = digits,
  digits_cor = digits,
  digits_sd = digits,
  include_denom = FALSE,
  percent_first = FALSE,
  hybrid_fisher = FALSE,
  simulate_p_value_fisher = FALSE,
  include_estimate_diff = FALSE,
  factor_name_own_row = FALSE,
  cat_out_of_row = FALSE,
  include_overall_column = FALSE,
  hide_level_logical = FALSE,
  use_interpuncts = FALSE,
  default_param_trans = NULL,
  default_param_atrans = NULL
)

Arguments

template	existing first_table_options to populate defaults
digits	digits used for formatting variables by default
include_p	digits used for formatting p values by default
p_digits	whether to include p values in table
small_p_format	format for small p values
small_p_cutoff	cutoff for small p values
include_n	whether to include number of non-missing values for each row
include_n_per_col	whether to include the number of individuals in each column
workspace	default workspace passed onto fisher.test
default_non_parametric	whether to default to non parametric tests for continuous variables
na_text	text to use for NA values
pretty_p	whether to format p values for display
p_sig_fig	whether to use significant figures for p value (rather than decimal digits)
p_n_sig_fig	number of significant figures
escape_name	whether to escape the row name when displayed as HTML
hide_single_level	whether to hide levels for factors when only one
cor_method	default correlation method for cor_row
digits_percent	digits used by default for percentages (overrides digits)
digits_cor	digits used by default for correlation (overrides digits)
digits_sd	digits used by default for standard deviation in parametric rows (overrides digits)
include_denom	whether to include the denominator for categorical variables
percent_first	whether to put the percent before the n for categorical variables
hybrid_fisher	whether to use a hybrid approach for fisher.test and >2x2 tables
simulate_p_value_fisher	whether to simulate p-values for fisher.test and >2x2 tables
include_estimate_diff	whether to include an estimate of the difference for continuous data (with appropriate estimates for parametric and non-parametric data)
factor_name_own_row	whether to have the name of a factor in a row on its own; only affects huxtable output
cat_out_of_row	whether percentages in categories should be calculated out of row rather than column
include_overall_column	whether to include an overall column in addition to separate columns by column variable
hide_level_logical	hide the display of the level TRUE for logical rows
use_interpuncts	replaces decimal points with interpuncts; most commonly used for Lancet journals
default_param_trans	default transformation for parametric data prior to calculating mean and standard deviation
default_param_atrans	default transformation for parametric data prior to calculating reporting standard deviation

NikNakk/firsttable documentation built on Feb. 8, 2025, 4:13 a.m.