R/mode.R

In brandonsie/bms: Brandon Sie's Personal R Package

#' calculate mode from numeric vector (e.g. to indicate peak of density plot)
#' takes numeric vector, outputx x axis value of y axis peak
#' https://stackoverflow.com/questions/13133297/calculating-peaks-in-histograms-or-density-functions
#' ... for use in ggridges::geom_density_ridges to ignore second parameter of quantiles
#'
#' @param vector numeric vector from which to calculate mode
#' @param ... additional parameters, not used
#'
#' @export

mode_fun <- function(vector, ...){
  d <- stats::density(vector)
  mode = d$x[d$y == max(d$y)]

}