Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gamma #427

Closed
Tracked by #421
spsanderson opened this issue Apr 24, 2024 · 0 comments
Closed
Tracked by #421

Gamma #427

spsanderson opened this issue Apr 24, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@spsanderson
Copy link
Owner

spsanderson commented Apr 24, 2024

Function:

#' Calculate Akaike Information Criterion (AIC) for Gamma Distribution
#'
#' This function calculates the Akaike Information Criterion (AIC) for a gamma 
#' distribution fitted to the provided data.
#'
#' @family Utility
#' @author Steven P. Sanderson II, MPH
#'
#' @description
#' This function estimates the shape and scale parameters of a gamma distribution 
#' from the provided data using maximum likelihood estimation, and then calculates 
#' the AIC value based on the fitted distribution.
#'
#' @param .x A numeric vector containing the data to be fitted to a gamma distribution.
#'
#' @details
#' This function fits a gamma distribution to the provided data using maximum 
#' likelihood estimation. It estimates the shape and scale parameters of the 
#' gamma distribution using maximum likelihood estimation. Then, it calculates 
#' the AIC value based on the fitted distribution.
#' 
#' Initial parameter estimates: The function uses the method of moments 
#' estimates as starting points for the shape and scale parameters of the 
#' gamma distribution.
#' 
#' Optimization method: The function uses the optim function for optimization. 
#' You might explore different optimization methods within optim for potentially 
#' better performance.
#' 
#' Goodness-of-fit: While AIC is a useful metric for model comparison, it's 
#' recommended to also assess the goodness-of-fit of the chosen model using 
#' visualization and other statistical tests.
#'
#' @examples
#' # Example 1: Calculate AIC for a sample dataset
#' set.seed(123)
#' x <- rgamma(30, shape = 1)
#' util_gamma_aic(x)
#'
#' @return
#' The AIC value calculated based on the fitted gamma distribution to the provided data.
#'
#' @name util_gamma_aic
NULL

#' @export
#' @rdname util_gamma_aic
util_gamma_aic <- function(.x) {
  # Tidyeval
  x <- as.numeric(.x)
  
  # Negative log-likelihood function for gamma distribution
  neg_log_lik_gamma <- function(par, data) {
    shape <- par[1]
    scale <- par[2]
    n <- length(data)
    -sum(dgamma(data, shape = shape, scale = scale, log = TRUE))
  }
  
  # Get initial parameter estimates: method of moments
  pe <- TidyDensity::util_gamma_param_estimate(x)$parameter_tbl |>
    subset(method == "EnvStats_MMUE")
  
  # Fit gamma distribution using optim
  fit_gamma <- optim(
    c(pe$shape, pe$scale), 
    neg_log_lik_gamma, 
    data = x
  )
  
  # Extract log-likelihood and number of parameters
  logLik_gamma <- -fit_gamma$value
  k_gamma <- 2 # Number of parameters for gamma distribution (shape and scale)
  
  # Calculate AIC
  AIC_gamma <- 2 * k_gamma - 2 * logLik_gamma
  
  # Return AIC
  return(AIC_gamma)
}

Example:

> set.seed(123)
> x <- rgamma(30, shape = 1)
> util_gamma_aic(x)
[1] 58.11738
> tt <- fitdistrplus::fitdist(x, "gamma", start = list(shape = 1, rate = 1))
> tt$aic
[1] 58.11738
@spsanderson spsanderson self-assigned this Apr 24, 2024
@spsanderson spsanderson added the enhancement New feature or request label Apr 24, 2024
@spsanderson spsanderson added this to the TidyDensity 1.4.0 milestone Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

1 participant