combine.summaryTable: Combine summary statistics table

In inTextSummaryTable: Creation of in-Text Summary Table

Combine summary statistics table

Description

• A new table is created, combining the tables by rows.

• The attributes of the combined summary table are obtained by combining the attributes of all summary tables (and removing duplicates).

Usage

## S3 method for class 'summaryTable'
combine(..., summaryTables, combineVar = NULL, combineDir = c("row", "col"))

Arguments

...	summaryTable objects.
summaryTables	List of summaryTable objects.
combineVar	(optional) String with name of a new variable tracking from which table each record originally come from. The label for each table is extracted from the names of the summaryTables list, or 1:length(tables) if the list is not named. If not specified (by default), the tables will be combined but the information on which input table: each record from the combined table belongs to will not be retained.
combineDir	String indicating on which direction: 'row' or 'col' (a.k.a column) the information on the table appartenance (combineVar) will be displayed when the table is exported.

Details

• In case only a set of tables contain categorical variable, in nested rows, so the variable and variableGroup variables, these variables are included as last in the 'row variables' attribute of the combined table.

• Only one row is retained for the columns totals per column variable (the first one in order of appearance).
  The column totals are not included if the column variable(s) are not the same across tables, or if the totals differ between tables.

Value

A combined summaryTable.

Author(s)

Laure Cougnaud

inTextSummaryTable documentation built on Sept. 12, 2023, 5:06 p.m.