Skip to content

Commit

Permalink
Add gengamma docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seananderson committed Jan 6, 2024
1 parent d03bcbb commit 21b34c1
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
17 changes: 17 additions & 0 deletions R/families.R
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,23 @@ lognormal <- function(link = "log") {
#' @rdname families
#' @examples
#' gengamma(link = "log")
#' @details
#' The `gengamma()` family was implemented by J.T. Thorson and uses the Prentice
#' (1974) parameterization such that the lognormal occurs as the internal
#' parameter `gengamma_Q` (reported in `print()` as "Generalized gamma lambda")
#' approaches 0.
#'
#' @references
#'
#' *Generalized gamma family*:
#'
#' Prentice, R.L. 1974. A log gamma model and its maximum likelihood estimation.
#' Biometrika 61(3): 539–544. \doi{10.1093/biomet/61.3.539}
#'
#' Stacy, E.W. 1962. A Generalization of the Gamma Distribution. The Annals of
#' Mathematical Statistics 33(3): 1187–1192. Institute of Mathematical
#' Statistics.

gengamma <- function(link = "log") {
linktemp <- substitute(link)
if (!is.character(linktemp))
Expand Down
14 changes: 14 additions & 0 deletions man/families.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 21b34c1

Please sign in to comment.