inTextSummaryTable-flextable-args: Common arguments for the functionalities of the inTextSummaryTable package for flextable export.

Description

Common arguments for the functionalities of the inTextSummaryTable package for flextable export.

Value

No return value, used for the documentation of R functions for 'flextable' output

Arguments

style

(flextable output) String with table style, either 'report' or 'presentation'. This parameter affects the fontsize, font family, color of the text and background, and table dimensions of the table.

rowTotalLab

(flextable output) string with label for the row with total.

rowAutoMerge

(flextable output) Logical, if TRUE (by default) automatically merge rows, e.g. in case there is only one sub-category (e.g. categorical variable with only one group) or only one statistic per category.

rowVarFormat

(flextable output) Named list with special formatting for the rowVar. Currently, only possibility is to set the variable elements in bold, with: list(var1 = "bold"). (Use 'variable' for var or 'variableGroup' for group within categorical variables.)

rowPadBase

(flextable output) Base padding for row (in points), 14.4 by default (corresponds to 0.2 inches)

fontname

(flextable output) String with font name, by default: 'Times' if style is 'report' and 'Tahoma' if style is 'presentation'.

fontsize

(flextable output) Integer with font size, by default: 8 if style is 'report' and 10 if style is 'presentation'.

margin

(flextable output) Margin in the document in inches (1 by default). This is used to specify the width of the table, from: [pageDim[1] - 2 * margin].

colorTable

(flextable output) Named character vector with color for the table background/body/text/line, e.g. created with the getColorPaletteTable function.

landscape

(flextable output) Logical, if TRUE the file is in landscape format.
By default: FALSE if style is 'report' and TRUE if style is 'presentation'.

footer

(flextable output) Character vector with footer(s) for the table. Set to NULL (by default) if no footer should be included.

vline

(flextable output) String mentioning how vertical lines should be included in the body of the table, either:

'none' (default): no vertical lines included
'auto': vertical lines included between sub-groups

hline

(flextable output) String mentioning how horizontal lines should be included in the body of the table, either:

'none': no horizontal lines included
'auto' (default): horizontal lines included between sub-groups

file

String with path of the file where the table should be exported. The file should have the extension: '.html'. If NULL, the summary table is not exported but only returned as output. If byVar is specified, each table is exported to a separated file with the suffix: 'file_[i].html' with i the index of the file.

colHeaderMerge

(flextable output) Logical, if TRUE (FALSE by default) the column header is merged.