Gamma: Gamma Class

In albgarre/biorisk: What the Package Does (One Line, Title Case)

Gamma Class

Description

An element for a gamma distribution

Super classes

biorisk::RiskElement -> biorisk::NA -> Gamma

Methods

Public methods

• Gamma$new()

• Gamma$point_estimate()

• Gamma$clone()

Inherited methods

• biorisk::RiskElement$boxplot()
• biorisk::RiskElement$check_input_types()
• biorisk::RiskElement$cummulative_plot()
• biorisk::RiskElement$cummulative_plot_2D()
• biorisk::RiskElement$density_plot()
• biorisk::RiskElement$density_plot_2D()
• biorisk::RiskElement$get_output()
• biorisk::RiskElement$get_output_2D()
• biorisk::RiskElement$get_output_type()
• biorisk::RiskElement$histogram()
• biorisk::RiskElement$map_input()
• biorisk::RiskElement$quantiles()
• biorisk::RiskElement$quantiles_2D()
• biorisk::RiskElement$save_as_distribution()
• biorisk::RiskElement$save_as_vector()
• biorisk::RiskElement$simulate()
• biorisk::RiskElement$simulate_2D()
• biorisk::RiskElement$simulate_level()

---

Method new()

Creates a new instance of this R6 class.

Usage

Gamma$new(name, units = NA, output_unit = NA, level = 0)

Arguments

name

A character defining the name for the element

units

A character vector of units for each input

output_unit

A character with the unit of the output

level

Level of the distribution (for 2D Monte Carlo). By default, 0

Returns

A new instance of the element

---

Method point_estimate()

Returns the expected value

Usage

Gamma$point_estimate()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Gamma$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

albgarre/biorisk documentation built on Feb. 23, 2025, 5:19 a.m.