rdecision (version 1.1.2)

NormModVar: A model variable whose uncertainty follows a Normal distribution

Description

An R6 class representing a model variable with Normal uncertainty.

Author

Andrew J. Sims

Super class

rdecision::ModVar -> NormModVar

Methods

Public methods

• NormModVar$new()

• NormModVar$is_probabilistic()

• NormModVar$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 a model variable with normal uncertainty.

Usage

NormModVar$new(description, units, mu, sigma)

Arguments

description

A character string describing the variable.

units

Units of the quantity; character string.

mu

Hyperparameter with mean of the Normal distribution for the uncertainty of the variable.

sigma

Hyperparameter equal to the standard deviation of the normal distribution for the uncertainty of the variable.

Returns

A NormModVar object.

---

Method is_probabilistic()

Tests whether the model variable is probabilistic.

Usage

NormModVar$is_probabilistic()

Returns

TRUE if probabilistic.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

NormModVar$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

A model variable for which the uncertainty in its point estimate can be modelled with a Normal distribution. The hyperparameters of the distribution are the mean (mu) and the standard deviation (sd) of the uncertainty distribution. The value of mu is the expected value of the variable. Inherits from class ModVar.