riskyr (version 0.1.0)

as_pc: Display a probability as a (rounded) percentage.

Description

as_pc is a function that displays a probability prob as a percentage (rounded to n.digits decimals).

Usage

as_pc(prob, n.digits = 2)

Arguments

prob

A probability (as a scalar or vector of numeric values from 0 to 1).

n.digits

Number of decimal places to which percentage is rounded. Default: n.digits = 2.

Value

A percentage (as a numeric value).

Details

as_pc and its complement function as_pb allow toggling the display of numeric values between percentages and probabilities.

See Also

is_prob verifies a probability; is_perc verifies a percentage; is_valid_prob_set verifies the validity of probability inputs; num contains basic numeric variables; init_num initializes basic numeric variables; prob contains current probability information; comp_prob computes current probability information; freq contains current frequency information; comp_freq computes current frequency information; comp_complement computes a probability's complement; comp_comp_pair computes pairs of complements.

Other utility functions: as_pb

Other display functions: as_pb

Examples

# NOT RUN {
as_pc(.50)                # =>  50
as_pc(1/3)                # =>  33.33
as_pc(1/3, n.digits = 0)  # =>  33

as_pc(pi)                 # => 314.16 + Warning that prob is not in range.
as_pc(as_pb(12.3))        # =>  12.3

prob.seq <- seq(0, 1, by = 1/10)
perc.seq <- seq(0, 100, by = 10)

as_pc(prob.seq)  # =>   0  10  20  30  40  50  60  70  80  90 100
as_pb(perc.seq)  # => 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0

perc.seq == as_pc(as_pb(perc.seq))            # => all TRUE
prob.seq == as_pb(as_pc(prob.seq))            # => some FALSE due to rounding errors!
round(prob.seq, 4) == as_pb(as_pc(prob.seq))  # => all TRUE (both rounded to 4 decimals)

# }