R/filter_results.R

In timwilson/soty: Calculate Performance Points For Various Archery Rounds

#' Filters a data frame by round and equipment class and applies a score multiplier.
#'
#' All event scores are contained in a single data frame. This function filter the data frame by the
#' 'round' and 'class' columns and applies a multiplier to the score column to adjust for a one-day, two-day, or
#' three-day event.
#' @param results A dataframe containing scores from various archery events.
#' @param archery_round The specific round to filter.
#' @param equipment_class The specific equipment class to filter.
#' @param divisor A divisor to apply to each score (default = 1).
#' @return A new dataframe containing the filtered results.
#' @importFrom dplyr filter
#' @importFrom dplyr mutate
#' @importFrom dplyr %>%
#' @export
filter_results <- function(results, archery_round, equipment_class, divisor = 1) {
  df <- results %>%
    filter(round == archery_round, class == equipment_class) %>%
    mutate(score = score / divisor)

  return (df)
}