inTextSummaryTable-DT-args {inTextSummaryTable}

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

Description

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

Arguments

expandVar

(DT output) Character vector with variables of the summary table which should be expanded in the data.

pageDim

(DT output) Numeric vector of length 2 with page width and height, in number of rows (currently only the height is used (e.g. c(NA, 4))

noEscapeVar

(DT output) Character vector with variables of summaryTable which shouldn't be escaped in the table (e.g. containing URLs).

barVar

(DT output) Character vector with variables of summaryTable that should be represented as a bar.

file

String with path of the file where the table should be exported. The file should have the extension: '.docx'. 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].docx' with i the index of the file.

Value

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