R/0_beta-utils.R

In LambertW: Probabilistic Models to Analyze and Gaussianize Heavy-Tailed, Skewed Data

#' @title Utilities for parameter vector beta of the input distribution
#' @name beta-utils
#' 
#' @description
#' The parameter \eqn{\boldsymbol \beta} specifies the input distribution
#' \eqn{X \sim F_X(x \mid \boldsymbol \beta)}.
#' 
#' @inheritParams common-arguments
#' @param beta numeric; vector \eqn{\boldsymbol \beta} of the input
#' distribution; specifications as they are for the R implementation of this
#' distribution. For example, if \code{distname = "exp"}, then \code{beta = 2}
#' means that the rate of the exponential distribution equals \eqn{2}; if
#' \code{distname = "normal"} then \code{beta = c(1,2)} means that the mean and
#' standard deviation are 1 and 2, respectively.

#' @keywords math utilities
#' 
NULL