R/slice_max_helper.R

In PatrickCoyle/cmisc: What the Package Does (One Line, Title Case)

#' select row with maximum value of a variable for each grouping variable
#'
#' @param df a data frame
#' @param group_var a grouping variable
#' @param max_var a numeric variable
#' @param n number of elements to select from each group
#' @examples
#' library(dplyr)
#' mtcars %>% slice_max_helper(vs, mpg)
#'
#' @export
slice_max_helper <- function(df, group_var, max_var, n = 1) {
  df %>%
    dplyr::group_by({{group_var}}) %>%
    dplyr::slice_max({{max_var}}, with_ties = F, n = n) %>%
    dplyr::ungroup()
}