prAddDescUnitColumn: Add a units column to the results

View source: R/getDescriptionStatsBy_prAddDescUnitColumn.R

prAddDescUnitColumnR Documentation

Add a units column to the results

Description

Add a units column to the results

Usage

prAddDescUnitColumn(results, x, use_units, units_column_name)

Arguments

results

The results that we want to add the column to

x

If a data.frame it will be used as the data source for the variables in the ... parameter. If it is a single variable it will be the core value that want the statistics for. In the print this is equivalent to the output of this function.

use_units

If the Hmisc package's units() function has been employed it may be interesting to have a column at the far right that indicates the unit measurement. If this column is specified then the total column will appear before the units (if specified as last). You can also set the value to "name" and the units will be added to the name as a parenthesis, e.g. Age (years).

units_column_name

The name of the units column. Used if use_units = TRUE

Value

results with added column


gforge/Gmisc documentation built on Aug. 30, 2023, 7:38 a.m.