.distributional_family {epiparameter} | R Documentation |
Get the underlying distributions names from a <distribution>
object from
the distributional package in R distribution naming convention.
Description
Get the underlying distributions names from a <distribution>
object from
the distributional package in R distribution naming convention.
Usage
.distributional_family(x, base_dist = TRUE)
Arguments
x |
An |
base_dist |
A boolean |
Details
Get and standardise distribution name. For untransformed
distributions (e.g. distributional::dist_gamma()
) it will return the
distribution name. For transformed distributions (e.g.
distributional::dist_mixture()
) it will get the name of the underlying
distribution(s) by default (base_dist = TRUE
). Distribution names are
returned in the R naming style (e.g. lognormal is "lnorm"
). When
base_dist = FALSE
transformed distributions return the name of the
transformation (e.g. "mixture"
).
Value
A character
vector.