Skip to contents

Create a family of probability distributions for excess count detection.

Usage

excodeFamily(name, nb_size = NA, shared_nb_size = FALSE)

Arguments

name

Name of the probability distribution that should be used. Either "Poisson" or "NegBinom".

nb_size

Size parameter of the Negative Binomial distribution. Only relevant if 'MultiState' model is used with a Negative Binomial dsitribution.

shared_nb_size

Logical indicating whether nb_size parameter is shared across multiple time series. Only relevant if name is "NegBinom".

Value

An excodeFamily object.

See also

Examples


excode_family_pois <- excodeFamily("Poisson")
excode_family_pois
#> excodeFamily: Poisson