Skip to contents

Beta response family

Source: R/family.R
beta_family.Rd

beta_family() defines a one-response distribution for continuous proportions strictly inside (0, 1), with formulas for mean mu and scale sigma. Write family = beta_family(). Unqualified beta() is base::beta(), the Euler beta function, and is not a drmTMB family.

Usage

beta_family()

beta()

Value

A drm_family object.

Details

The implemented contract is logit(mu) = eta_mu, log(sigma) = eta_sigma, and internal precision phi = 1 / sigma^2. Larger sigma therefore means more variation around the mean, not more precision. Ordinary unlabelled random intercepts and independent numeric slopes such as (1 | id) and (0 + x | id) may enter the logit-mu predictor; sigma remains fixed-effect in this first slice.

Functions

  • beta(): Deprecated alias; use beta_family() instead. Not exported (it would mask base::beta()). Call drmTMB:::beta() only if an old script still needs the alias.

Examples

beta_family()
#> $name
#> [1] "beta"
#> 
#> $family
#> [1] "beta"
#> 
#> $n_response
#> [1] 1
#> 
#> $dpars
#> [1] "mu"    "sigma"
#> 
#> $links
#>      mu   sigma 
#> "logit"   "log" 
#> 
#> attr(,"class")
#> [1] "drm_family"