format_number: Format a number for displaying.

In randomchars42/eenv: Import often used functions, settings and packages

Description

This function respects eenv_signif_digits, eenv_signif_bottom, eenv_decimals as default.

Usage

format_number(x, type = "float", decimals = eenv_decimals,
  signif_digits = eenv_signif_digits,
  signif_bottom = eenv_signif_bottom, force_perc_decimals = FALSE)

Arguments

x	The number to format.
type	The type of number ("int", "perc", "float", "p").
decimals	The number of decimals to round to (not p-values).
signif_digits	The number of non-zero digits to display for p-values.
signif_bottom	The number below which "< NUMBER" is displayed for p-values.
force_perc_decimals	TRUE if decimals should be displayed for percentages.

Value

A string.

See Also

Other variables and functions for displaying numbers: eenv_decimals, eenv_signif_bottom, eenv_signif_digits, eenv_signif_steps, format_float, format_int, format_pad, format_perc, format_p

randomchars42/eenv documentation built on May 20, 2019, 1:29 p.m.