data |
Data.frame with dataset to consider for the summary table.
|
summaryTable |
A summaryTable object.
|
var |
Character vector with variable(s) of data,
to compute statistics on.
If NULL (by default), counts by row/column variable(s) are computed.
To also return counts of the rowVar in case other var
are specified, you can include: 'all' in the var.
Missing values, if present, are filtered
(also for the report of number of subjects/records).
|
varFlag |
Character vector, subset of var with variable(s)
of type 'flag' (with 'Y', 'N' or ” for empty/non specified value).
Only the counts for records flagged (with 'Y') are retained.
|
varLabInclude |
Logical, if TRUE
the name of the summary statistic variable(s) (var)
are included in the table.
This is automatically set to TRUE if more than one variable(s)
and is specified, and FALSE if only one variable is specified.
|
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'.
|
rowVarLab |
Named character vector with
label for 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.
|
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.
|
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.
|
colVar |
Character vector with variable(s) to be included in columns.
If multiple variables are specified, the variables should
be sorted in hierarchical order,
and are included in multi-columns layout.
Use: 'variable' to include the variables to summarize: var
(if multiple) in different columns.
|
colTotalInclude |
Logical, if TRUE (FALSE by default) include the summary
statistics across columns in a separated column.
|
colTotalLab |
String, label for the total column 'Total' by default.
|
subjectVar |
String, variable of data with subject ID,
'USUBJID' by default.
|
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)
|
statsValueLab |
String with label for the statistic value,
'StatisticValue' by default.
This is only included in the table if the statistics provided in
stats are not named and if no colVar is specified.
|
|
(optional) Named list with functions for additional custom
statistics to be computed.
Each function:
has as parameter, either: 'x': the variable (var) to compute
the summary statistic on or 'data': the entire dataset
returns the corresponding summary statistic as a numeric vector
For example, to additionally compute the coefficient of variation, this can be set to:
list(statCVPerc = function(x) sd(x)/mean(x)*100) (or cv).
|
type |
String with type of table:
'summaryTable': summary table with statistics for numeric variable
'countTable': count table
'auto' (by default): 'summaryTable' if the variable is numeric,
'countTable' otherwise
|
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.
|
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).
|
pageDim |
Numeric vector of length 2 with page width and height.
Depending on outputType:
|
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.
|