rdecision (version 1.1.2)

BetaModVar: A model variable whose uncertainty follows a Beta distribution

Description

An R6 class representing a model variable whose uncertainty is described by a Beta distribution.

Author

Andrew J. Sims

Super class

rdecision::ModVar -> BetaModVar

Methods

Public methods

• BetaModVar$new()

• BetaModVar$is_probabilistic()

• BetaModVar$clone()

Inherited methods

• rdecision::ModVar$SD()
• rdecision::ModVar$description()
• rdecision::ModVar$distribution()
• rdecision::ModVar$get()
• rdecision::ModVar$is_expression()
• rdecision::ModVar$mean()
• rdecision::ModVar$mode()
• rdecision::ModVar$quantile()
• rdecision::ModVar$r()
• rdecision::ModVar$set()
• rdecision::ModVar$units()

---

Method new()

Create an object of class BetaModVar.

Usage

BetaModVar$new(description, units, alpha, beta)

Arguments

description

A character string describing the variable.

units

Units of the variable, as character string.

alpha

parameter of the Beta distribution.

beta

parameter of the Beta distribution.

Returns

An object of class BetaModVar.

---

Method is_probabilistic()

Tests whether the model variable is probabilistic, i.e. a random variable that follows a distribution, or an expression involving random variables, some of which follow distributions.

Usage

BetaModVar$is_probabilistic()

Returns

TRUE if probabilistic

---

Method clone()

The objects of this class are cloneable with this method.

Usage

BetaModVar$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

A model variable for which the uncertainty in the point estimate can be modelled with a Beta distribution. The hyperparameters of the distribution are the shape parameters (alpha and beta) of the uncertainty distribution. Inherits from class ModVar.