NormModVar: A model variable whose uncertainty follows a Normal...
In rdecision: Decision Analytic Modelling in Health Economics
NormModVar R Documentation
A model variable whose uncertainty follows a Normal distribution
Description
An R6 class representing a model variable with Normal
uncertainty.
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.
Super class
rdecision::ModVar -> NormModVar
Methods
Public methods
Inherited methods
Method new()
Create a model variable with normal uncertainty.
Usage
NormModVar$new(description, units, mu, sigma)
Arguments
descriptionA character string describing the variable.
unitsUnits of the quantity; character string.
muHyperparameter with mean of the Normal distribution for
the uncertainty of the variable.
sigmaHyperparameter 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
deepWhether to make a deep clone.
Author(s)
Andrew J. Sims andrew.sims@newcastle.ac.uk
rdecision documentation built on April 3, 2025, 6:09 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| NormModVar | R Documentation |
A model variable whose uncertainty follows a Normal distribution
Description
An R6 class representing a model variable with Normal uncertainty.
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.
Super class
rdecision::ModVar -> NormModVar
Methods
Public methods
Inherited methods
Method new()
Create a model variable with normal uncertainty.
Usage
NormModVar$new(description, units, mu, sigma)
Arguments
descriptionA character string describing the variable.
unitsUnits of the quantity; character string.
muHyperparameter with mean of the Normal distribution for the uncertainty of the variable.
sigmaHyperparameter 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
deepWhether to make a deep clone.
Author(s)
Andrew J. Sims andrew.sims@newcastle.ac.uk
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.