parameters: Parameters of a Distribution

In vincenzocoia/distionary: Create and Evaluate Probability Distributions

Parameters of a Distribution

Description

Get or set the parameters of a distribution, if applicable. See details.

Usage

parameters(distribution)

parameters(distribution) <- value

Arguments

distribution	Distribution.
value	A list of named parameter values, or NULL.

Details

If a distribution is made by specifying parameter values (e.g., mean and variance for a Normal distribution; shape parameters for a Beta distribution), it is useful to keep track of what these parameters are. This is done by adding parameters to the list of objects defining the distribution; for instance, distribution(parameters = c(shape1 = 1.4, shape2 = 3.4)). Note that no checks are made to ensure the parameters are valid. It's important to note that, in this version of distionary, manually changing the parameters after the distribution has been created will not change the functionality of the distribution, because the parameters are never referred to when making calculations.

Value

A list of the distribution parameters. More specifically, returns the "parameters" entry of the list making up the probability distribution.

Examples

a <- dst_beta(1, 2)
parameters(a)

b <- distribution(mean = 5)
parameters(b)
parameters(b) <- list(t = 7)
parameters(b)

vincenzocoia/distionary documentation built on Feb. 26, 2025, 11:09 a.m.