summarize_nejm_horz: Create a summarization for a categorical set of column versus...

View source: R/transform-nejm.R

summarize_nejm_horzR Documentation

Create a summarization for a categorical set of column versus a numerical row in NEJM style

Description

Given a row and column object from the parser apply a Kruskal test and output the results horizontally. 5 X (n + no. categories + test statistic)

Usage

summarize_nejm_horz(
  table,
  row,
  column,
  cell_style,
  pformat = NULL,
  msd = FALSE,
  quant = c(0.25, 0.5, 0.75),
  overall = NULL,
  test = FALSE,
  useNA = "no",
  ...
)

Arguments

table

The table object to modify

row

The row variable object to use (numerical)

column

The column variable to use (categorical)

cell_style

list; cell styling functions

pformat

numeric, character or function; A formatting directive to be applied to p-values

msd

logical; Include mean and standard deviation with quantile statistics

quant

numeric; Vector of quantiles to include. Should be an odd number since the middle value is highlighted on display.

overall

logical or character; Include overall summary statistics for a categorical column. Character values are assumed to be true and used as column header.

test

logical or function; include statistical test results. Function signature must be function(row, col, cell_style, ...)

useNA

character; Specifies whether to include NA counts in the table. The allowed values correspond to never "no" (Default), only if the count is positive "ifany" and even for zero counts "always". An NA column is always excluded.

...

absorbs additional arugments. Unused at present.

Value

The modified table object


spgarbet/tangram documentation built on Feb. 12, 2023, 7:13 p.m.