gasmodel (version 0.6.1)

distr: Get the Table of Supported Distributions

Description

A function listing distributions and their parametrizations supported by the gas() function. Output can be filtered using several arguments.

Usage

distr(filter_distr = NULL, filter_param = NULL, filter_type = NULL,
  filter_dim = NULL, filter_orthog = NULL, filter_default = NULL)

Value

A data.frame with columns:

distr_title

The title of the distribution.

param_title

The title of the parametrization.

distr

The distribution.

param

The parametrization.

type

The data type.

dim

The dimension.

orthog

The indication of whether the parametrization is orthogonal.

default

The indication of whether the parameterization is the default for the distribution.

Arguments

filter_distr

An optional vector of distributions by which the output is filtered.

filter_param

An optional vector of parametrizations by which the output is filtered.

filter_type

An optional vector of data types by which the output is filtered.

filter_dim

An optional vector of dimensions by which the output is filtered.

filter_orthog

An optional logical value indicating whether the parametrization is orthogonal by which the output is filtered.

filter_default

An optional logical value indicating whether the parameterization is the default for the distribution by which the output is filtered.

See Also

distr_density(), distr_mean(), distr_var(), distr_score(), distr_fisher(), distr_random(), gas()

Examples

# List all available distributions
distr()

# List only distributions for count data
distr(filter_type = "count")

# Show default parametrization for the negative binomial distribution
distr(filter_dist = "negbin", filter_default = TRUE)