prAddTotalDescColumn: Add a total column to the results

View source: R/getDescriptionStatsBy_prAddTotalDescColumn.R

prAddTotalDescColumnR Documentation

Add a total column to the results

Description

Add a total column to the results

Usage

prAddTotalDescColumn(
  results,
  x,
  by,
  numbers_first,
  total_col_show_perc,
  show_all_values,
  useNA,
  useNA.digits,
  html,
  digits,
  continuous_fn,
  factor_fn,
  prop_fn,
  percentage_sign,
  default_ref,
  header_count = NULL,
  add_total_col
)

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.

by

The variable that you want to split into different columns

numbers_first

If the number should be given or if the percentage should be presented first. The second is encapsulated in parentheses ().

total_col_show_perc

This is by default true but if requested the percentages are suppressed as this sometimes may be confusing.

show_all_values

Show all values in proportions. For factors with only two values it is most sane to only show one option as the other one will just be a complement to the first, i.e. we want to convey a proportion. For instance sex - if you know gender then automatically you know the distribution of the other sex as it's 100 % - other %. To choose which one you want to show then set the default_ref parameter.

useNA

This indicates if missing should be added as a separate row below all other. See table for useNA-options. Note: defaults to ifany and not "no" as table does.

useNA.digits

The number of digits to use for the missing percentage, defaults to the overall digits.

html

If HTML compatible output should be used. If FALSE it outputs LaTeX formatting

digits

The number of decimals used

continuous_fn

The method to describe continuous variables. The default is describeMean.

factor_fn

The method used to describe factors, see describeFactors.

prop_fn

The method used to describe proportions, see describeProp.

percentage_sign

If you want to suppress the percentage sign you can set this variable to FALSE. You can also choose something else that the default % if you so wish by setting this variable.

default_ref

The default reference when dealing with proportions. When using 'dplyr' syntax ('tidyselect') you can specify a named vector/list for each column name.

header_count

Set to TRUE if you want to add a header count, e.g. Smoking; No. 25 observations, where there is a new line after the factor name. If you want a different text for the second line you can specifically use the sprintf formatting, e.g. "No. %s patients".

add_total_col

This adds a total column to the resulting table. You can also specify if you want the total column "first" or "last" in the column order.

Value

results with added column


Gmisc documentation built on Aug. 26, 2023, 1:07 a.m.