Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

BetaNoncentral

Noncentral Beta Distribution Class


Description

Mathematical and statistical functions for the Noncentral Beta distribution, which is commonly used as the prior in Bayesian modelling.

Details

The Noncentral Beta distribution parameterised with two shape parameters, α, β, and location, λ, is defined by the pdf,

f(x) = exp(-λ/2) ∑_{r=0}^∞ ((λ/2)^r/r!) (x^{α+r-1}(1-x)^{β-1})/B(α+r, β)

for α, β > 0, λ ≥ 0, where B is the Beta function.

Value

Returns an R6 object inheriting from class SDistribution.

Distribution support

The distribution is supported on [0, 1].

Default Parameterisation

BetaNC(shape1 = 1, shape2 = 1, location = 0)

Omitted Methods

N/A

Also known as

N/A

Super classes

Public fields

name

Full name of distribution.

short_name

Short name of distribution for printing.

description

Brief description of the distribution.

packages

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

Methods

Public methods


Method new()

Creates a new instance of this R6 class.

Usage
BetaNoncentral$new(
  shape1 = NULL,
  shape2 = NULL,
  location = NULL,
  decorators = NULL
)
Arguments
shape1

(numeric(1))
First shape parameter, shape1 > 0.

shape2

(numeric(1))
Second shape parameter, shape2 > 0.

location

(numeric(1))
Location parameter, defined on the non-negative Reals.

decorators

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


Method setParameterValue()

Sets the value(s) of the given parameter(s).

Usage
BetaNoncentral$setParameterValue(
  ...,
  lst = NULL,
  error = "warn",
  resolveConflicts = FALSE
)
Arguments
...

ANY
Named arguments of parameters to set values for. See examples.

lst

(list(1))
Alternative argument for passing parameters. List names should be parameter names and list values are the new values to set.

error

(character(1))
If "warn" then returns a warning on error, otherwise breaks if "stop".

resolveConflicts

(logical(1))
If FALSE (default) throws error if conflicting parameterisations are provided, otherwise automatically resolves them by removing all conflicting parameters.


Method clone()

The objects of this class are cloneable with this method.

Usage
BetaNoncentral$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jordan Deenichin

References

McLaughlin, M. P. (2001). A compendium of common probability distributions (pp. 2014-01). Michael P. McLaughlin.

See Also


distr6

The Complete R6 Probability Distributions Interface

v1.5.2
MIT + file LICENSE
Authors
Raphael Sonabend [aut, cre] (<https://orcid.org/0000-0001-9225-4654>), Franz Kiraly [aut], Peter Ruckdeschel [ctb] (Author of distr), Matthias Kohl [ctb] (Author of distr), Nurul Ain Toha [ctb], Shen Chen [ctb], Jordan Deenichin [ctb], Chengyang Gao [ctb], Chloe Zhaoyuan Gu [ctb], Yunjie He [ctb], Xiaowen Huang [ctb], Shuhan Liu [ctb], Runlong Yu [ctb], Chijing Zeng [ctb], Qian Zhou [ctb]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.