DiscreteElement: DiscreteElement Class

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

DiscreteElement Class

Description

This is the parent class for Elements that have a discrete output

Super class

biorisk::RiskElement

Methods

Public methods

• DiscreteElement$new()

• DiscreteElement$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$point_estimate()
• 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

DiscreteElement$new(
  name,
  input_names = NA,
  units = NA,
  element_type = "",
  output_var = "",
  output_unit = "",
  input_types = list(),
  level = 0
)

Arguments

name

A character defining the name for the element

input_names

A character vector with the names of the inputs

units

A character vector of units for each input

element_type

A character with the type of element

output_var

A character with the name of the output variable

output_unit

A character with the unit of the output

input_types

A list defining types of each input

level

Level of the module for 2D Monte Carlo. By default, 0

Returns

A new instance

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DiscreteElement$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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