R/check_times.R

In stevenranney/AnglerCreelSurveySimulation: Simulate a Bus Route Creel Survey of Anglers

# Created: 05/20/24

#' Check that start, wait, or end times for a surveyor are provided and reasonable
#' 
#' @author Steven H. Ranney
#' 
#' @description This is a helper function used in \code{get_total_value} to check that 
#' surveyor for \code{start_time}, \code{wait_time}, \code{end_time}, 
#' and \code{fishing_day_length} are valid. 
#' 
#' @param start_time The start time of the clerk. An \code{int} between 0 and 
#' \code{fishing_day_length}. The default is \code{NULL}.
#' 
#' @param wait_time the wait time of the clerk. The default is \code{NULL}. The default is 
#' \code{NULL}
#' 
#' @param end_time the end time of the clerk. An \code{int} between 0 and 
#' \code{fishing_day_length}. The default is \code{NULL}.
#' 
#' @param fishing_day_length the total length of the fishing day, in hours, as \code{int}. 0800hrs to 2000hrs = 
#' fishing_day_length of 12 hours.
#' 
#' @details Two of the three \code{start_time}, \code{wait_time}, or \code{end_time} must be 
#' provided. The third will be calculated.
#' 
#' @examples 
#' library(dplyr)   
#' set.seed(256)
#'
#' start_time <- NULL
#' end_time <- NULL
#' wait_time <- NULL
#' 
#' # Will return error
#' \dontrun{check_times(start_time = start_time, end_time = end_time, wait_time = wait_time, 
#' fishing_day_length = 12)}
#' 
#' start_time <- 2
#' end_time <- NULL
#' wait_time <- NULL
#'
#' # Will return an error
#' \dontrun{check_times(start_time = start_time, end_time = end_time, wait_time = wait_time, 
#' fishing_day_length = 8)}
#'
#' start_time <- 2
#' end_time <- 6
#' wait_time <- NULL
#' fishing_day_length <- 8
#'
#' check_times(start_time = start_time, end_time = end_time, wait_time = wait_time, 
#' fishing_day_length = 8)
#'                    
#' @export
#' 


check_times <- function(
    start_time = NULL, 
    wait_time = NULL, 
    end_time = NULL, 
    fishing_day_length = NULL){
  
  not_nulls <- sum(c(!is.null(start_time), !is.null(wait_time), !is.null(end_time)))
  
  if(not_nulls < 2){
    stop("Two of start_time, wait_time, and end_time must be provided.", call. = FALSE)
  }
  
  if(is.null(fishing_day_length)){
    stop("Please provide value for fishing_day_length.", call. = FALSE)
  }
  
  if(is.null(start_time)) { 
    start_time <- end_time - wait_time
    }
  if(is.null(wait_time)){
    wait_time <- end_time - start_time
  }
  if(is.null(end_time)){
    end_time <- start_time + wait_time
  }

  if(end_time > fishing_day_length){
    stop("end_time cannot be greater than fishing_day_length.")
  }
  
  if(start_time > fishing_day_length){
    stop("start_time cannot be greater than fishing_day_length.")
  }
  if(start_time > end_time){
    stop("start_time cannot be greater than end_time.")
  }
  
  
    return(list("start_time" = start_time, 
              'wait_time' = wait_time, 
              'end_time' = end_time))

  
}