BetaModVar: A model variable whose uncertainty follows a Beta...
In rdecision: Decision Analytic Modelling in Health Economics
BetaModVar R Documentation
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.
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.
Super class
rdecision::ModVar -> BetaModVar
Methods
Public methods
Inherited methods
Method new()
Create an object of class BetaModVar.
Usage
BetaModVar$new(description, units, alpha, beta)
Arguments
descriptionA character string describing the variable.
unitsUnits of the variable, as character string.
alphaparameter of the Beta distribution.
betaparameter 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
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.
| BetaModVar | R Documentation |
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.
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.
Super class
rdecision::ModVar -> BetaModVar
Methods
Public methods
Inherited methods
Method new()
Create an object of class BetaModVar.
Usage
BetaModVar$new(description, units, alpha, beta)
Arguments
descriptionA character string describing the variable.
unitsUnits of the variable, as character string.
alphaparameter of the Beta distribution.
betaparameter 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
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.