list_distributions: List the distributions a specification may use

In simulab: Simulates a Wide Variety of Data Shapes, Sizes and Distributions

List the distributions a specification may use

Description

list_distributions() reports the distribution catalogue. Each row names one distribution, the parameters it takes in the order a positional call supplies them, and whether it carries a quantile function. Only a distribution with a quantile function can be a marginal in simulate_copula().

Usage

list_distributions(pattern = NULL, copula = NULL)

Arguments

pattern	Optional regular expression matched against distribution names.
copula	If TRUE, keep only distributions usable as copula marginals; if FALSE, keep only those that are not. NULL, the default, keeps every distribution.

Value

A base data.frame with one row per distribution and columns distribution, parameters, n_parameters and copula.

Examples

head(list_distributions())

# Distributions whose name mentions normal.
list_distributions("normal")

# Distributions that cannot be a copula marginal.
list_distributions(copula = FALSE)

simulab documentation built on Oct. 15, 2026, 5:08 p.m.