tabmeans_svy: Generate Summary Tables of Mean Comparisons for Statistical...
In tab: Functions for Creating Summary Tables for Statistical Reports

Description Usage Arguments Details Value Note Author(s) References See Also Examples

This function compares the mean of a continuous variable across levels of a categorical variable and summarizes the results in a clean table for a statistical report. Similar to tabmeans, but for survey data. Relies heavily on the survey package [1, 2].

tabmeans.svy(x, y, svy, latex = FALSE, xlevels = NULL, yname = "Y variable",
             test = "Wald", decimals = 1, p.decimals = c(2, 3), p.cuts = 0.01,
             p.lowerbound = 0.001, p.leading0 = TRUE, p.avoid1 = FALSE,
             n.column = FALSE, n.headings = TRUE, bold.colnames = TRUE,
             bold.varnames = FALSE, variable.colname = "Variable",
             print.html = FALSE, html.filename = "table1.html")

`svy`	Survey design object created by a call to `svydesign` [1, 2].
`x`	Character string specifying categorical `x` variable name. Must match one of `names(svy$variables)`.
`y`	Character string specifying continuous `y` variable name. Must match one of `names(svy$variables)`.
`latex`	If `TRUE`, object returned is formatted for printing in LaTeX using `xtable` [1]; if `FALSE`, formatted for copy-and-pasting from RStudio into a word processor.
`xlevels`	Optional character vector to label the levels of `x`, used in the column headings. If unspecified, the function uses the values that `x` takes on.
`yname`	Optional label for the continuous variable.
`test`	Either `"Wald"` for Wald test or `"LRT"` for likelihood ratio test to test for equivalent mean `y` across levels of `x`.
`decimals`	Number of decimal places for means and standard deviations or standard errors.
`p.decimals`	Number of decimal places for p-values. If a vector is provided rather than a single value, number of decimal places will depend on what range the p-value lies in. See `p.cuts`.
`p.cuts`	Cut-point(s) to control number of decimal places used for p-values. For example, by default `p.cuts = 0.1` and `p.decimals = c(2, 3)`. This means that p-values in the range [0.1, 1] will be printed to two decimal places, while p-values in the range [0, 0.1) will be printed to three decimal places.
`p.lowerbound`	Controls cut-point at which p-values are no longer printed as their value, but rather <lowerbound. For example, by default `p.lowerbound = 0.001`. Under this setting, p-values less than 0.001 are printed as `<0.001`.
`p.leading0`	If `TRUE`, p-values are printed with 0 before decimal place; if `FALSE`, the leading 0 is omitted.
`p.avoid1`	If `TRUE`, p-values rounded to 1 are not printed as 1, but as `>0.99` (or similarly depending on `p.decimals` and `p.cuts`).
`n.column`	If `TRUE`, the table will have a column for (unweighted) sample size.
`n.headings`	If `TRUE`, the table will indicate the (unweighted) sample size overall and in each group in parentheses after the column headings.
`bold.colnames`	If `TRUE`, column headings are printed in bold font. Only applies if `latex = TRUE`.
`bold.varnames`	If `TRUE`, variable name in the first column of the table is printed in bold font. Only applies if `latex = TRUE`.
`variable.colname`	Character string with desired heading for first column of table, which shows the `y` variable name.
`print.html`	If `TRUE`, function prints a .html file to the current working directory.
`html.filename`	Character string indicating the name of the .html file that gets printed if `print.html = TRUE`.

A character matrix with the requested table comparing mean y across levels of x. If latex = TRUE, the character matrix will be formatted for inserting into a Markdown/Sweave/knitr report using the xtable package [3].

If you wish to paste your tables into Word, you can use either of these approaches:

1. Use the write.cb function in the Kmisc package [4]. If your table is stored in a character matrix named table1, use write.cb(table1) to copy the table to your clipboard. Paste the result into Word, then highlight the text and go to Insert - Table - Convert Text to Table... OK.

2. Set print.html = TRUE. This will result in a .html file writing to your current working directory. When you open this file, you will see a nice looking table that you can copy and paste into Word. You can control the name of this file with html.filename.

If you wish to use LaTeX, R Markdown, knitr, Sweave, etc., set latex = TRUE and then use xtable [3]. You may have to set sanitize.text.function = identity when calling print.xtable.

If you have suggestions for additional options or features, or if you would like some help using any function in tab, please e-mail me at vandomed@gmail.com. Thanks!

Dane R. Van Domelen

1. Lumley T (2012). survey: analysis of complex survey samples. R package version 3.28-2, https://cran.r-project.org/package=survey.

2. Lumley T (2014). Analysis of complex survey samples. Journal of Statistical Software 9(1): 1-19.

3. Dahl DB (2013). xtable: Export tables to LaTeX or HTML. R package version 1.7-1, https://cran.r-project.org/package=xtable.

4. Kevin Ushey (2013). Kmisc: Kevin Miscellaneous. R package version 0.5.0. https://CRAN.R-project.org/package=Kmisc.

Acknowledgment: This material is based upon work supported by the National Science Foundation Graduate Research Fellowship under Grant No. DGE-0940903.

svydesign
svyglm
tabfreq
tabmeans
tabmedians
tabmulti
tabglm
tabcox
tabgee
tabfreq.svy
tabmedians.svy
tabmulti.svy
tabglm.svy