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

Uniform #431

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

Uniform #431

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 Uniform Distribution
#'
#' This function calculates the Akaike Information Criterion (AIC) for a uniform 
#' distribution fitted to the provided data.
#'
#' @family Utility
#' @author Steven P. Sanderson II, MPH
#'
#' @description
#' This function estimates the min and max parameters of a uniform distribution 
#' from the provided data and then calculates the AIC value based on the fitted 
#' distribution.
#'
#' @param .x A numeric vector containing the data to be fitted to a uniform distribution.
#'
#' @details
#' This function fits a uniform distribution to the provided data. It estimates 
#' the min and max parameters of the uniform distribution from the range of the data.
#' Then, it calculates the AIC value based on the fitted distribution.
#' 
#' Initial parameter estimates: The function uses the minimum and maximum values 
#' of the data as starting points for the min and max parameters of the uniform 
#' distribution.
#' 
#' Optimization method: Since the parameters are directly calculated from the 
#' data, no optimization is needed.
#' 
#' 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 <- runif(30)
#' util_uniform_aic(x)
#'
#' @return
#' The AIC value calculated based on the fitted uniform distribution to the provided data.
#'
#' @name util_uniform_aic
NULL

#' @export
#' @rdname util_uniform_aic
util_uniform_aic <- function(.x) {
  # Tidyeval
  x <- as.numeric(.x)
  
  # Estimate min and max parameters
  min_val <- min(x)
  max_val <- max(x)
  
  # Calculate AIC
  k_uniform <- 2 # Number of parameters for uniform distribution (min and max)
  logLik_uniform <- -length(x) * log(max_val - min_val)
  AIC_uniform <- 2 * k_uniform - 2 * logLik_uniform
  
  # Return AIC
  return(AIC_uniform)
}

Example:

> set.seed(123)
> x <- runif(30)
> util_uniform_aic(x)
[1] 1.061835
> fitdistrplus::fitdist(x, "unif", start = list(min = 0, max = 1))$aic
[1] 1.061835
@spsanderson spsanderson self-assigned this Apr 25, 2024
@spsanderson spsanderson added the enhancement New feature or request label Apr 25, 2024
@spsanderson spsanderson added this to the TidyDensity 1.4.0 milestone Apr 25, 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