Return a commentary snippet for any decimal value. Formats the number as a percentage and provides simple up/down commentary

Return a commentary snippet for any decimal value. Formats the number as a percentage and provides simple up/down commentary

Usage

single_percent(x, description = "up", unchanged_limit, ...)

Arguments

x

a numeric value, as a decimal value. E.g. 10% would be passed as 0.1.

description

code of descriptive words used in commentary. Defaults to "up"; up/down/unchanged.

unchanged_limit

numeric, the value below which you consider the parameter to not represent a change in either direction. Defaults to 0.01.

...

additional arguments to pass to the scales::percent function

Value

Returns a brief commentary (including the figure for increases or decreases) as a string