tableDate {reporttools} | R Documentation |
Many data analyses start with a display of descriptive statistics of important variables. This function takes a data frame of date variables and possible grouping (such as e.g. treatment), weighting, and subset variables and provides a LaTeX table of descriptive statistics separately per group and jointly for all observations, per variable.
tableDate(vars, weights = NA, subset = NA, group = NA, stats = c("n", "min", "q1", "median", "mean", "q3", "max", "na"), col.tit = NA, print.pval = TRUE, cap = "", lab = "", font.size = "footnotesize", longtable = TRUE, disp.cols = NA, nams = NA)
vars |
A data frame of date variables. See nams for an alternative
way of specifying the variables to be displayed. |
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). |
col.tit |
Specify titles of columns. |
print.pval |
If print.pval == TRUE , p-values of a Mann-Whitney or Kruskal-Wallis
test for a difference between groups are provided. |
cap |
The caption of the resulting LaTeX table. |
lab |
The label of the resulting LaTeX table. |
font.size |
Font size for the generated table in LaTeX. |
longtable |
If TRUE , function makes use of package longtable in LaTex to generate tables that
span more than one page. If FALSE , generates a table in tabular environment. |
disp.cols |
Only included for backward compatibility. Needs to be a vector of (some of) the default
statistics character strings if not equal to NA . From package version 1.0.2 use of stats is recommended. |
nams |
A vector of strings, containing the names corresponding to the variables in vars , if vars
is not a data frame but a list of variables. These are then the names that appear in the LaTeX table.
This option is only kept for backward compatibility. |
Outputs the LaTeX table.
If either one of the arguments group
, weights
, or subset
is different from NA
and if vars
is a list, then it is assumed that all variables
in vars
are of equal length.
If longtable = TRUE
(which is the default), the function generates a table that may be more than one page
long, you need to include the package longtable in the LaTeX source.
If a list of variables is given to vars
, not all of these variables need to be of the same length. However,
note the Warning below.
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, Code Snippets, 31(1).
http://www.jstatsoft.org/v31/c01.
set.seed(1977) diagnosis <- as.Date(round(runif(10, min = 35000, max = 40000)), origin = "1899-12-30") death <- as.Date(round(runif(10, min = 35000, max = 40000)), origin = "1899-12-30") vars <- data.frame(diagnosis, death) group <- sample(c(rep("A", 5), rep("B", 5))) tableDate(vars = vars, group = group, stats = c("n", "min", "median", "max", "na"), cap = "Table of date variables.", lab = "tab: descr stat date") ## suppose we have weighted observations weights <- c(2, 3, 1, 4, rep(1, 6)) subset <- 1:5 tableDate(vars = vars, weights = weights, subset = subset, cap = "Table of date variables.", lab = "tab: descr stat date") ## For backward compatibility, disp.cols and nams are still working. ## If a list is given to vars, the variables can be of different length. ## However, then weights, subset, and group must be set to NA (the default). tableDate(vars = list(diagnosis, death), nams = c("Diagnosis", "Death"), disp.cols = c("n", "na", "min", "max"), col.tit = c("observations", "percentage", "cum. percentage"), print.pval = FALSE, cap = "Table of date variables.", lab = "tab: descr stat date")