R/filter_to_season.R

In aftonsteps/croptimizer: Stardew Valley Croptimizer

#' Filter To Season
#'
#' Filters crop data to only crops which grow in the specified season.
#'
#' @param season character containing current season
#' @param crop_data data.frame containing crop data, defaults to package data `crops`
#'
#' @return data.frame containing crop data filtered to current season crops
#' @export
#'
#' @examples
#' ## Filters to fall season
#' filter_to_season(season = "fall")
filter_to_season <- function(season,
                             crop_data = croptimizer::crops,
                             seasonsal_values = croptimizer::seasonal_values) {

  ## Error checking
  if (class(season) != "character" | length(season) > 1) {
    stop("season must be character of length 1")
  }

  ## Standardize season names
  season <- tolower(season)

  if (! season %in% c("spring", "summer", "fall", "winter")) {
    stop("season must be one of spring, summer, fall, or winter")
  }

  if (!"data.frame" %in% class(crop_data)) {
    stop("crop data must be of class data.frame")
  }

  ## Get the current season column
  season_col <-
    which(colnames(crop_data) == paste0("growth_season_", season))

  ## Filter to crops that are in the selected season
  subset_vec <- crop_data[, season_col] == TRUE
  filtered_data <- crop_data[subset_vec, ]

  filtered_data$days_remaining_in_growth_season <-
    filtered_data$total_days_in_growth_season

  ## Get the first season column (spring)
  spring_col <-
    which(colnames(filtered_data) == "growth_season_spring")
  current_season_offset <- season_col - spring_col

  ## For multi-season crops that have passed some of their seasons,
  ## decrement days remaining
  for (r_idx in 1:nrow(filtered_data)) {
    ## If num seasons > 1, decrement by days per season * num past grow seasons
    if (filtered_data$total_num_seasons[r_idx] > 1 &
        current_season_offset > 0) {
      ## Loop over 1 to number of seasons in this row
      for (c_idx in 1:current_season_offset) {
        ## If encounter a TRUE, decrement by that number of seasons
        if (filtered_data[r_idx, season_col - c_idx]) {
          filtered_data$days_remaining_in_growth_season[r_idx] <-
            filtered_data$days_remaining_in_growth_season[r_idx] -
            seasonal_values$days_per_season
        }
      }
    }
  }

  return(filtered_data)
}