exportSummaryStatisticsTableToFlextable: Export summary table to a flextable object, e.g. to be...

In inTextSummaryTable: Creation of in-Text Summary Table

Export summary table to a flextable object, e.g. to be exported in Word or PowerPoint.

Description

Export summary table to a flextable object, e.g. to be exported in Word or PowerPoint.

Usage

exportSummaryStatisticsTableToFlextable(
  summaryTable,
  rowVar = getAttribute(summaryTable, "rowVar"),
  rowVarInSepCol = NULL,
  rowVarTotalInclude = getAttribute(summaryTable, "rowVarTotalInclude"),
  statsLayout = getAttribute(summaryTable, "statsLayout", default = "row"),
  statsVar = getAttribute(summaryTable, "statsVar"),
  statsLabInclude = getAttribute(summaryTable, "statsLabInclude", default =
    length(statsVar) > 1),
  rowVarLab = getAttribute(summaryTable, "rowVarLab", default = getLabelVar(rowVar,
    labelVars = labelVars)),
  rowVarTotalInSepRow = NULL,
  vline = c("none", "auto"),
  hline = c("auto", "none"),
  rowAutoMerge = TRUE,
  rowVarFormat = NULL,
  rowTotalLab = NULL,
  colHeaderMerge = TRUE,
  landscape = (style == "presentation"),
  margin = 1,
  rowPadBase = 14.4,
  title = NULL,
  footer = NULL,
  style = "report",
  colorTable = getColorPaletteTable(style = style),
  fontname = switch(style, report = "Times", presentation = "Tahoma"),
  fontsize = switch(style, report = 8, presentation = 10),
  file = NULL,
  pageDim = NULL,
  columnsWidth = NULL,
  labelVars = NULL
)

Arguments

summaryTable	Summary table as provided by the formatSummaryStatisticsTable
rowVar	Character vector with variable(s) to be included in the rows. If multiple variables are specified, the variables should be sorted in hierarchical order (e.g. body system class before adverse event term) and are nested in the table.
rowVarInSepCol	Character vector with rowVar that should be included in separated columns. By default (NULL), all row variables are nested in the first column of the table. To include the groups within a var variable in a separated column, set: rowVarInSepCol == 'variableGroup'.
rowVarTotalInclude	Character vector with rowVar for which the total should be reported. If the higher row variable is specified, the total across all rows is reported. For the export, these variable(s) are formatted as factor with 'Total' as the first level.
statsLayout	String with layout for the statistics names (in case more than one statistic is included), among: row (by default for 'flextable' output): All statistics are included in different rows in the first column of the table (after the row variable(s)) 'col' (by default for 'DT' output): Statistics are included in separated columns (last row of the header). This option is not compatible with categorical variable(s). 'rowInSepCol': Statistics are included in different rows, but in a separated column than the rowVar variable(s)
statsVar	Character vector with columns of summaryTable with statistic variables. For the export: if not specified, all columns of data besides row, column variables, 'variable', 'variableGroup' and 'isTotal' are considered.
statsLabInclude	Logical, if TRUE include the statistic label in the table. By default only included if more than one statistic variables are available in the table.
rowVarLab	Named character vector with label for the rowVar variable(s).
rowVarTotalInSepRow	Character vector with rowVarTotalInclude (not in rowVarInSepCol) for which the total should be included in a separated row labelled 'Total'. Otherwise (by default) the total is included in the header row of each category.
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
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.)
rowTotalLab	(flextable output) string with label for the row with total.
colHeaderMerge	(flextable output) Logical, if TRUE (FALSE by default) the column header is merged.
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'.
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].
rowPadBase	(flextable output) Base padding for row (in points), 14.4 by default (corresponds to 0.2 inches)
title	Character vector with title(s) for the table. Set to NULL (by default) if no title should be included. If multiple are specified, specified for each element of byVar (in order of the levels).
footer	(flextable output) Character vector with footer(s) for the table. Set to NULL (by default) if no footer should be included.
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.
colorTable	(flextable output) Named character vector with color for the table background/body/text/line, e.g. created with the getColorPaletteTable function.
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'.
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.
pageDim	Numeric vector of length 2 with page width and height. Depending on outputType: 'flextable': in inches 'DT': in number of rows in the table. Currently only the height is used (e.g. c(NA, 4))
columnsWidth	(expert mode) Column widths of the table. This is only used for flextable and DT tables. For flextable, note that the widths should be set to fit into the document page (see getDimPage).
labelVars	(optional) Named character vector with label for the row, column variable(s) or variable(s) to summarize. Labels specified via dedicated parameter: e.g. rowVarLab, colVarLab, varLab have priority on this parameter.

Value

flextable object with summary table If summaryTable is a list of summary tables, returns a list of flextable.

Author(s)

Laure Cougnaud

inTextSummaryTable documentation built on June 22, 2024, 9:24 a.m.