return: Return Level Function

In vincenzocoia/distionary: Create and Evaluate Univariate Probability Distributions

Return Level Function

Description

Compute return levels (quantiles) from a distribution by inputting return periods.

Usage

eval_return(distribution, at)

enframe_return(..., at, arg_name = ".arg", fn_prefix = "return", sep = "_")

Arguments

distribution, ...	A distribution, or possibly multiple distributions in the case of ....
at	Vector of return periods >=1.
arg_name	For enframe_, name of the column containing the function arguments.
fn_prefix	For enframe_, name of the function to appear in the column(s).
sep	When enframe'ing more than one distribution, the character that will be separating the fn_name and the distribution name.

Value

The return levels associated with the specified return periods in vector form (for eval_) and data frame or tibble form (for enframe_). This function is simply the quantile function evaluated at 1 - 1 / at.

See Also

Other distributional representations: eval_cdf(), eval_chf(), eval_density(), eval_hazard(), eval_odds(), eval_pmf(), eval_quantile(), eval_survival()

Examples

d <- dst_unif(0, 4)
eval_return(d, at = c(2, 25, 100, 200))
enframe_chf(d, at = c(2, 25, 100, 200))

vincenzocoia/distionary documentation built on Oct. 13, 2024, 12:04 a.m.