RegCategoricalSoftmax: Categorical regression with softmax link density (univariate,...

In luisdamiano/BayesHMM: Full Bayesian Inference for Hidden Markov Models

Description

It can be used to specify either a prior distribution for a model parameter or a likelihood function for an observation model.

Usage

RegCategoricalSoftmax(xBeta = NULL, M = NULL, N = NULL,
  ordered = NULL, equal = NULL, bounds = list(NULL, NULL),
  trunc = list(NULL, NULL), k = NULL, r = NULL, param = NULL)

Arguments

xBeta	Either a fixed value or a prior density for the parameter of the regression.
M	An integer with the number of covariates in the observation regression model.
N	An integer with the number of trials (fixed quantity).
ordered	(optional) A logical setting an increasing ordering constraint on any univariate parameter and any unconstrained parameter vector. Ordered simplices (e.g. Categorical, Multinomial, Dirichlet) are currently not implemented. Most useful for location parameters to break symmetries and fix label switching as shown in Betancourt (2017). It defaults to unordered parameters.
equal	(optional) A logical setting whether the parameter takes the same value in every hidden state, i.e. the parameter is shared across states. It defaults to unequal parameters.
bounds	(optional) A list with two elements specifying the lower and upper bound for the parameter space. Use either a fixed value for a finite bound or NULL for no bounds. It defaults to an unbounded parameter space.
trunc	(optional) A list with two elements specifying the lower and upper bound for the domain of the density function. Use either a fixed value for a finite bound or NULL for no truncation. It defaults to an unbounded domain.
k	(optional) The number of the hidden state for which this density should be used. This argument is mostly for internal use: you should not use it unless you are acquainted with the internals of this software.
r	(optional) The dimension of the observation vector dimension for which this density should be used. This argument is mostly for internal use: you should not use it unless you are acquainted with the internals of this software.
param	(optional) The name of the parameter. This argument is mostly for internal use: you should not use it unless you are acquainted with the internals of this software.

Value

A Density object.

References

Betancourt, Michael (2017) Identifying Bayesian Mixture Models Stan Case Studies Volume 4. Link.

See Also

Other Density: Bernoulli, Beta, Binomial, Categorical, Cauchy, CholeskyLKJCor, Density, Dirichlet, Exponential, GammaDensity, Gaussian, ImproperUniform, InitialFixed, InitialSoftmax, InverseWishart, MVGaussianCholeskyCor, MVGaussian, MVStudent, Multinomial, NegativeBinomialLocation, NegativeBinomial, Poisson, RegBernoulliLogit, RegBinomialLogit, RegBinomialProbit, RegGaussian, Student, TransitionFixed, TransitionSoftmax, Wishart

Examples

RegCategoricalSoftmax(
  xBeta = Gaussian(0, 10),
  M     = 3,
  N     = 10
)

luisdamiano/BayesHMM documentation built on May 20, 2019, 2:59 p.m.