tableContinuous {reporttools} | R Documentation |
Many data analyses start with a display of descriptive statistics of important variables. This function takes a list of numeric variables and a possible grouping variable (such as e.g. treatment) and provides a LaTeX table of descriptive statistics separately per group and jointly for all observations, per variable. User-defined statistics can be provided.
tableContinuous(vars, nams, weights = NA, subset = NA, group = NA, stats = c("n", "min", "q1", "median", "mean", "q3", "max", "s", "iqr", "na"), prec = 1, col.tit = NA, print.pval = c("none", "anova", "kruskal")[1], declare.zero = 10^-10, cap = "", lab = "", disp.cols = NA)
vars |
A list of continuous variables. |
nams |
A vector of strings, containing the names corresponding to the variables in vars . These are the names
that appear in the LaTeX table. |
weights |
Optional vector of weights of each observation. |
subset |
Optional logical vector, indicates subset of observations to be used. |
group |
Optional grouping variable. |
stats |
Specify which descriptive statistics should be displayed in the table, by either directly providing
one or more of the default character strings (in arbitrary order) or a user-defined function. A user-defined
function must bear a name, take a vector as an argument (NA 's are removed by default) and return
a single number (the desired statistic). For details see the examples below. |
prec |
Specify number of decimals to be displayed. |
col.tit |
Specify titles of columns. |
print.pval |
If print.pval == "anova" , a p-values for an analysis of variance for a location
difference between groups is added to the table. If print.pval == "kruskal" a p-value of a Kruskal-Wallis test
is given. If group has only two levels, the respective p-value of a t- or Mann-Whitney test
is provided. Only applies if group is provided. |
declare.zero |
Computed descriptive statistics (not p-values) below that constant are set to 0. Yields nicer tables, especially when displaying centered or standardized variables. |
cap |
The caption of the resulting LaTeX table. |
lab |
The label of the resulting LaTeX table. |
disp.cols |
Only included for backward compatibility. Needs to be a vector built of (some of) the default statistics
character strings if not equal to NA . From package version 1.0.2 on use of stats is recommended. |
Outputs the LaTeX table.
If either one of the arguments group
, weights
, or subset
is different from NA
, then it
is assumed that all variables in vars
are of equal length.
Kaspar Rufibach (maintainer), kaspar.rufibach@ifspm.uzh.ch,
http://www.biostat.uzh.ch/aboutus/people/rufibach.html
Rufibach, K. (2009) reporttools: R-Functions to Generate LaTeX Tables of Descriptive Statistics. Journal of Statistical Software, to appear.
set.seed(1977) nams <- c("Var1", "Var2") group <- sample(c(rep("A", 50), rep("B", 50))) weights <- c(rep(1, 70), rep(0, 10), rep(2, 20)) ## display default statistics, provide neither group nor weights vars <- list(rnorm(20), rgamma(100, 2, 1)) tableContinuous(vars = vars, nams = nams, weights = NA, subset = NA, group = NA, stats = c("n", "min", "q1", "mean", "median", "q3", "max", "iqr", "na"), prec = 1, col.tit = NA, print.pval = "kruskal", cap = "Table of continuous variables.", lab = "tab: descr stat") ## display default statistics, only use a subset of observations, grouped analysis vars <- list(rnorm(100), rgamma(100, 2, 1)) tableContinuous(vars = vars, nams = nams, weights = weights, subset = c(rep(TRUE, 57), rep(FALSE, 100 - 57)), group = group, stats = c("n", "min", "q1", "mean", "median", "q3", "max", "iqr", "na"), prec = 1, col.tit = NA, print.pval = "kruskal", cap = "Table of continuous variables.", lab = "tab: descr stat") ## supply user-defined statistics: trimmed mean and IQR as an unbiased estimate ## of the population standard deviation in case of normal data my.stats <- list("n", "mean", "$\bar{x}_{trim}$" = function(x){return(mean(x, trim = .05))}, "iqr", "IQR.unbiased" = function(x){return(IQR(x) / (2 * qnorm(3 / 4)))}) tableContinuous(vars, nams, weights = weights, group = group, stats = my.stats, prec = 1, col.tit = NA, print.pval = "kruskal", cap = "Table of continuous variables.", lab = "tab: descr stat") ## disp.cols can still be used, for backward compatibility tableContinuous(vars, nams, subset = rep(TRUE, 40), group = group, disp.cols = c("n", "min", "median", "max", "iqr", "na"), prec = 1, col.tit = NA, print.pval = "kruskal", cap = "Table of continuous variables.", lab = "tab: descr stat")