R/bat_max.R

In Swaha294/ipl: Data and functions for analysing IPL matches played in 2008-2020

#' Calculate the maximum runs made by a batsman in a given season
#'
#'
#' @param player the batsman for whom maximum runs have to be calculated, as
#' a character vector
#' @param yr the season for which the maximum runs of the given batsman have to
#' be calculated, as a numeric vector
#'
#' @return `bat_max` returns a `tbl_df` with one row and two columns.
#'
#'
#' @examples
#'
#' library(ipl)
#'
#' # Find maximum runs made by Virat Kohli in the year 2016
#' bat_max("V Kohli", 2016)
#'
#' # Find maximum runs made by AB de Villiers in the year 2019
#' bat_max("AB de Villiers", 2019)
#' @importFrom magrittr "%>%"
#' @import dplyr
#'
#' @export

bat_max <- function(player, yr) {
  if (!is.character(player)) {
    stop("Invalid input: player input should be a character vector")
  } else if (!is.numeric(yr)) {
    stop("Invalid input: year input should be a numeric vector")
  } else if (!(player %in% deliveries$batsman)) {
    stop(paste0(`player`, "not found!"))
  } else if (!(yr %in% deliveries$year)) {
    stop(paste0(`yr`, "Year not found"))
  } else {
    deliveries %>%
      filter(
        batsman %in% player,
        year %in% yr
      ) %>%
      group_by(id, year, batsman) %>%
      summarise(match_runs = sum(batsman_runs)) %>%
      ungroup() %>%
      group_by(year, batsman) %>%
      summarise(max_runs = max(match_runs)) %>%
      ungroup()
  }
}