getParams {DistributionFitR} | R Documentation |
Given a distribution family, this function attempts to retrieve the distribution parameters and various characteristics, such as: valid parameter ranges, whether they accept non-integer values and the support of the distribution.
getParams(fam, package)
fam |
character or list.
If |
package |
character. Optional argument if |
The family name is defined as the part of the function name that follows “d”,
“p”, “q” and “r”. So in case of the continuous uniform
the family name is “unif”.
The values returned by getParams
are included
in the DistributionFitR-package and updated with each package update.
Users may use it to update the library of parameter characteristics
themselves or find the function useful to use the parameter
characteristics retrieved for other purposes.
For getParams
a list with components, each of them a named vector: The
names are the arguments of the distribution family as specified in e.g. the
“r<distributionFamilyName>”-function, the value is described below:
lower |
named vector; values: numeric, lower bound of the respective parameter value |
upper |
named vector; values: numeric, upper bound of the respective
parameter value. Length and names must coincide with entry |
accepts_float |
named vector; values: boolean, |
defaults |
named vector; values: numeric, default values for the
respective parameter (needed for optimisation to work).
Length and names must coincide with entry |
log |
single boolean; |
discrete |
single boolean; |
support_min |
single numeric; left bound of support of the distributions density, i.e. minimum value where the density is not zero. |
support_max |
single numeric; right bound of support of the distributions density, i.e. maximum value where the density is not zero. |
supp_max_depends_on |
named vector; value: booleans, |
supp_max_depends_on |
named vector; value: booleans, |
Benedikt Geier, Borui Niklas Zhu
See also getFamilies
for a convenient wrapper available to the
user where distributions are extracted from whole packages.
getParams("beta", package = "stats")
getParams("unif", package = "stats" )