Skip to contents

Write a probability as a quantile label

Source: R/naming_grammar.R
q_label.Rd

Writes q, two integer-percent digits, x and one decimal-percent digit, so 0.025 becomes "q02x5".

Usage

q_label(p)

Arguments

p

A numeric vector of probabilities.

Value

A character vector of labels, with NA for NA.

Details

The label loses information in two ways. A finer probability is rounded: 0.0125 becomes "q01x2". And p = 1 gives "q100x0", which q_value() cannot read. Keep p on the 0.001 grid and below 1.

See also

vignette("pipeline", package = "csalert"), whose naming-grammar section shows both limits.

Other naming grammar functions: csfmt_interpret(), csfmt_parse(), csfmt_var(), q_value()

Examples

q_label(c(0.025, 0.5, 0.975))
#> [1] "q02x5" "q50x0" "q97x5"

# limit 1: a probability finer than one decimal percent is rounded
q_value(q_label(0.0125))
#> [1] 0.012

# limit 2: p = 1 gives a three-digit label, and q_value() returns NA for it
q_label(1)
#> [1] "q100x0"
q_value(q_label(1))
#> [1] NA