summaryTable: 'summaryTable'

In inTextSummaryTable: Creation of in-Text Summary Table

summaryTable

Description

1. The summary statistics are computed in computeSummaryStatisticsTable, which creates a summaryTable object.

2. This object is exported to diverse formats via export

Multiple summaryTable objects are combined together with combine.summaryTable.

Details

The summaryTable is an intermediary object of the package. This contains the summary statistics as data.frame. This object contains:

• the row and column variable(s)

• the computed statistic(s):
  If type is:

  • 'summaryTable':

    • 'statN': number of subjects

    • 'statMean': mean of var

    • 'statSD': standard deviation of var

    • 'statSE': standard error of var

    • 'statMedian': median of var

    • 'statMin': minimum of var

    • 'statMax': maximum of var

    • 'statPerc': percentage of subjects

    • 'statPercTotalN': total number of subjects based on dataTotalPerc, denominator of statPerc

    • 'statm': number of records

  • 'countTable':

    • 'statN': number of subjects

    • 'statPercN' (or 'statPercm'): percentage of subjects (or records depending on statsPerc)

    • 'statPercTotalN' (or 'statPercTotalm'): total number of subjects (or records) based on dataTotalPerc, and used as denominator of statPercN (or 'statPercm')

    • 'statm': number of records

• computed statistics.
  The statistics are stored in columns corresponding to names of the statsVar.
  If the specified statistics are not named and of length 1, the statistics are stored in a column called: 'Statistic'.

• variables:

  • 'variable': variable name in case var is of length > 1

  • 'variableGroup': in case var is of length > 1 and for variable(s) used for count: elements of the variable

• 'isTotal': variable with logical flag, TRUE if the record contain the total by column

Additionally, the output contains an extra attribute 'summaryTable', which is a list composed of:

• 'statsVar': column name(s) of summary table with computed statistics included in the final table

• 'rowVar': column name(s) of summary table with row variable included in the final table. This parameter should be mainly used for qualitative variables and 'nests' together different rows in the final output table.

• 'rowVarLab': labels corresponding to the 'rowVar' attribute

• 'rowVarTotalInclude': row variables whose total will be included: rowVarTotalInclude and 'variableGroup' if the variable total should be included

• 'rowVarTotalInSepRow': row variables whose total will be included in a separated row: rowVarTotalInSepRow and 'variableGroup' if varTotalInSepRow

• 'colVar': column name(s) of summary table with column variable included in the final table

• 'colTotalLab': label for the total

Value

Not relevant

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