modelsum object.Format the information in object as a table using Pandoc coding or plain text, and cat it to stdout.
# S3 method for modelsum
summary(object, title = NULL, labelTranslations = NULL,
digits = NA, nsmall = NA, nsmall.ratio = NA, digits.test = NA,
show.intercept = NA, show.adjust = NA, text = FALSE,
removeBlanks = text, labelSize = 1.2, pfootnote = TRUE, ...)The data defining the table to display
Title for the table, defaults to NULL (no title)
A named list (or vector) where the name is the label in the
output to be replaced in the pretty rendering of modelsum by the character
string value for the named element of the list, e.g.,
list(age = "Age(years)", medsurv = "Median Survival"). This applies to the statistic
labels and the variable labels in the output.
Maximum number of digits to display for floating point numbers.
If NA (default), it uses the value from object$control$digits
(whose default is 3, which would result in, e.g., 12.3, 1.23, 0.123, and 0.012).
Minimum number of digits to the right of the decimal point to display for
floating point numbers. If NA (default), it uses the value from object$control$nsmall.
Allowed non-NA values are 0 <= nsmall <= 20.
Minimum number of digits to the right of the decimal point to display
for the ratio statistics (OR, HR, RR). If NA (default) it uses the value from
object$control$nsmall.ratio (whose default is 2).
Allowed values are 0 <= nsmall.ratio <= 20.
Number of digits to display for a p-value. Default is 5 (e.g. 0.12345).
Logical, denoting if the intercept should be shown for each line
Logical, denoting if the adjust variables should be shown for each line.
Logical, denoting whether to print out the text version.
Logical, denoting if any blank lines should be removed from the output.
Default is value of "text", and will be set to FALSE if text is FALSE.
Relative size difference between label column and other columns. Default is 1.2: label column ~20% bigger than other columns
Logical denoting if a footnote should be added describing the test used
to generate the p value. Default is FALSE.
Other arguments (not implemented a this time).
Results are cat'ed to stdout, and returned invisibly as a character vector.