dists: Information about supported and not yet supported...

In distreg.vis: Framework for the Visualization of Distributional Regression Models

Information about supported and not yet supported distribution families

Description

A dataset containing all of bamlss' exported and gamlss.dist families. This is the backbone of the package; whether you can use a distributional family or not depends on this dataset. Since 1.7.0 family betareg from the betareg package is also supported.

Usage

dists

Format

An object of class data.frame with 125 rows and 8 columns.

Details

This data.frame object contains one row for each distribution, and columns with the following content:

• dist_name: Name of the distribution.

• class: Either "bamlss" or "gamlss" detailing from which package the target distribution comes from.

• implemented: Is this distribution generally usable for plot_dist(), and was this usage already tested?

• moment_funs: Are functions implemented with which to calculate the moments of the distribution, given the parameters? This column is especially relevant for plot_moments(), in which the predicted moments are displayed.

• type_limits: Details the range the values from the distribution can have. Can be "both_limits", "one_limit", "no_limit" and "cat_limit" (for categorical distributions).

• l_limit, u_limit: Integers detailing where the limits of the distributions lie.

• type: Character string for the type of distribution. Can be "Discrete", "Continuous", "Mixed" and "Categorical".

Examples

## Find out which GAMLSS or BAMLSS families are supported

dists_char <- dists[dists$moment_funs, c("dist_name", "class")]

# GAMLSS families
dists_char[dists_char$class == "gamlss", "dist_name"]

# BAMLSS families
dists_char[dists_char$class == "bamlss", "dist_name"]

distreg.vis documentation built on Oct. 27, 2023, 9:07 a.m.