decorate: Decorate Distributions

Description Usage Arguments Details Value References See Also Examples

View source: R/decorate.R

Description

Functionality to decorate R6 Distributions (and child classes) with extra methods.

Usage

1
decorate(distribution, decorators, ...)

Arguments

distribution

([Distribution])
Distribution to decorate.

decorators

(character()) Vector of DistributionDecorator names to decorate the Distribution with.

...

ANY
Extra arguments passed down to specific decorators.

Details

Decorating is the process of adding methods to classes that are not part of the core interface (Gamma et al. 1994). Use listDecorators to see which decorators are currently available. The primary use-cases are to add numeric results when analytic ones are missing, to add complex modelling functions and to impute missing d/p/q/r functions.

Value

Returns a Distribution with additional methods from the chosen DistributionDecorator.

References

Gamma, Erich, Richard Helm, Ralph Johnson, and John Vlissides. 1994. “Design Patterns: Elements of Reusable Object-Oriented Software.” Addison-Wesley.

See Also

listDecorators() for available decorators and DistributionDecorator for the parent class.

Examples

1
2
3
4
5
B <- Binomial$new()
decorate(B, "CoreStatistics")

E <- Exponential$new()
decorate(E, c("CoreStatistics", "ExoticStatistics"))

distr6 documentation built on Sept. 6, 2021, 9:10 a.m.