R/percentify_min.R

In EmilHvitfeldt/percentify: Splitting a Dataset According to Percentile Ranges

#' Group a data.frame by percentile ranges in variable with constant upper bound
#'
#' This function is a small wrapper around \code{\link{percentify}}, where the
#' upper bound is a fixed value.
#'
#' There is a [ggplot2::autoplot()] to visualize the the percentile ranges.
#'
#' @inheritParams percentify
#' @param q Numerical values for upper bound of ranges. Must be between 0
#'   and 1.
#'
#' @return percentile grouped tibble
#' @export
#'
#' @family percentile samplers
#'
#' @examples
#' library(dplyr)
#' library(broom)
#' percent_mtcars <- percentify_min(mtcars, mpg, c(0.25, 0.5, 0.75, 1))
#'
#' percent_mtcars
#'
#' summarize(percent_mtcars,
#'           mean_hp = mean(hp),
#'           mean_wt = mean(wt),
#'           n_obs = n()
#'           )
#'
#' percent_mtcars %>%
#'   group_modify(~tidy(lm(disp ~ wt + cyl, data = .x)))
#'
#' library(ggplot2)
#' autoplot(percent_mtcars)
percentify_min <- function(data, var, q = numeric(), lower = 0) {
  if (any(q > 1)) {
    stop("All values of `q` much be lesser than 1.")
  }
  percentify(data, {{var}}, lower = rep(lower, length(q)), upper = q)
}