alias_as_fmt_fn: Convert Alias to Function

In cards: Analysis Results Data

Convert Alias to Function

Description

Accepted aliases are non-negative integers and strings.

The integers are converted to functions that round the statistics to the number of decimal places to match the integer.

The formatting strings come in the form "xx", "xx.x", "xx.x%", etc. The number of xs that appear after the decimal place indicate the number of decimal places the statistics will be rounded to. The number of xs that appear before the decimal place indicate the leading spaces that are added to the result. If the string ends in "%", results are scaled by 100 before rounding.

Usage

alias_as_fmt_fn(x, variable, stat_name)

Arguments

x	(integer, string, or function) a non-negative integer, string alias, or function
variable	(character) the variable whose statistic is to be formatted
stat_name	(character) the name of the statistic that is to be formatted

Value

a function

Examples

alias_as_fmt_fn(1)
alias_as_fmt_fn("xx.x")

cards documentation built on Oct. 4, 2024, 1:09 a.m.