SDistribution: Abstract Special Distribution Class

In alan-turing-institute/distr6: The Complete R6 Probability Distributions Interface

Abstract Special Distribution Class

Description

Abstract class that cannot be constructed directly.

Value

Returns error. Abstract classes cannot be constructed directly.

Super class

distr6::Distribution -> SDistribution

Public fields

package

Deprecated, use ⁠$packages⁠ instead.

packages

Packages required to be installed in order to construct the distribution.

Methods

Public methods

• SDistribution$new()

• SDistribution$clone()

Inherited methods

• distr6::Distribution$cdf()
• distr6::Distribution$confidence()
• distr6::Distribution$correlation()
• distr6::Distribution$getParameterValue()
• distr6::Distribution$iqr()
• distr6::Distribution$liesInSupport()
• distr6::Distribution$liesInType()
• distr6::Distribution$median()
• distr6::Distribution$parameters()
• distr6::Distribution$pdf()
• distr6::Distribution$prec()
• distr6::Distribution$print()
• distr6::Distribution$quantile()
• distr6::Distribution$rand()
• distr6::Distribution$setParameterValue()
• distr6::Distribution$stdev()
• distr6::Distribution$strprint()
• distr6::Distribution$summary()
• distr6::Distribution$workingSupport()

---

Method new()

Creates a new instance of this R6 class.

Usage

SDistribution$new(
  decorators,
  support,
  type,
  symmetry = c("asymmetric", "symmetric")
)

Arguments

decorators

(character())
Decorators to add to the distribution during construction.

support

⁠[set6::Set]⁠
Support of the distribution.

type

⁠[set6::Set]⁠
Type of the distribution.

symmetry

character(1)
Distribution symmetry type, default "asymmetric".

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SDistribution$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

alan-turing-institute/distr6 documentation built on July 8, 2024, 4:51 p.m.