WritePrintCtable {lazyWeave} | R Documentation |
Write and Print Comparison Tables
Description
Print Comparisons to the console or write the table to a file.
Usage
## S3 method for class 'ctable'
print(x, ...)
split_ctable(x, max.rows = 35, keepVarTogether = TRUE, ...)
write.ctable(x, round = 2, percent = TRUE, quartile = TRUE,
cwidth = NULL, caption = NULL, footnote = NULL, byVarN = FALSE,
size = "\\normalsize", descripCombine = TRUE, oddsCombine = TRUE,
markSignificant = FALSE, statHeader = "Statistics", name = FALSE,
var.label = TRUE, level = TRUE, total = TRUE, descriptive = TRUE,
missing = FALSE, missing.perc = FALSE, testStat = TRUE, odds = FALSE,
pval = TRUE, oneLine = FALSE, pvalFormat = "default",
pvalArgs = list(), cat = getOption("lazyWeave_cat"), ...)
Arguments
x |
A ctable object to be printed or written |
... |
Other arguments to be passed to |
max.rows |
The maximum number of rows to be displayed on a page. Variable groups are forced to be kept together. |
keepVarTogether |
Determines if variables are kept together when splitting a table across mulitple pages. When a single variable has more levels than can remain on one printed page, this must be set to FALSE. |
round |
The number of decimal places to be displayed for numeric values. |
percent |
Toggles if percentages or proportions are printed for categorical values |
quartile |
Toggles if quartiles or min and max are printed for numeric
values associated with the |
cwidth |
A vector giving the width of each column in the body of the table. The number of columns is not always obvious, and this vector is not recycled. If the length is inappropriate, a warning message will be printed indicating the correct number of columns. |
caption |
The name of the table. |
footnote |
A footnote for the table. |
byVarN |
Toggles if the N per group in |
size |
A character string denoting the size of the text for the table. This must be latex code, for example "\normalsize" or "\small." Remember to use to backslashes! |
descripCombine |
Toggles if descriptive statistics are combined.
It is strongly recommended that this be left |
oddsCombine |
Toggles if odds ratios are combined with the lower up upper confidence limits. |
markSignificant |
Toggles if significant results are printed in bold text. |
statHeader |
Character string giving the column heading for statistical summaries. |
name |
Toggles if the variable name is printed in the table. |
var.label |
Toggles if the variable label is printed in the table. |
level |
Toggles if the variable levels are printed in the table. This column is usually needed for categorical variables, and never needed for numeric variables. |
total |
Toggles if the totals column is printed in the table |
descriptive |
Toggles if descriptive statistics are printed. |
missing |
Toggles if the number of missing values are printed in the table. |
missing.perc |
Toggles if the percentage of missing values is printed in the table. |
testStat |
Toggles if the test statistics are printed. |
odds |
Toggles if odds ratios are printed. Only relevant to numeric variables. |
pval |
Toggles if the pvalue column is printed. |
oneLine |
When true, binary variables are printed with only one line per variable. This does not affect the printing of numeric variable or variables with more than two levels. |
pvalFormat |
Character string passed to |
pvalArgs |
A list of additional arguments to be passed to |
cat |
Logical. Determines if the output is returned as a character string
or returned via the |
Author(s)
Benjamin Nutter