tfrmt (version 0.3.0)

param_set: Set custom parameter-level significant digits rounding

Description

Set custom parameter-level significant digits rounding

Usage

param_set(...)

Value

list of default parameter-level significant digits rounding

Arguments

...

Series of name-value pairs, optionally formatted using glue::glue() syntax (note glue syntax is required for combined parameters).The name represents the parameter and the value represents the number of places to round the parameter to. For combined parameters (e.g., "{min}, {max}"), value should be a vector of the same length (e.g., c(1,1)).

Details

Type param_set() in console to view package defaults. Use of the function will add to the defaults and/or override included defaults of the same name. For values that are integers, use NA so no decimal places will be added.

Examples

# View included defaults
param_set()

# Update the defaults
param_set("{mean} ({sd})" = c(2,3), "pct" = 1)

# Separate mean and SD to different lines
param_set("mean" = 2, "sd" = 3)

# Add formatting using the glue syntax
param_set("{pct} %" = 1)