R/inside_interval.R

In jmzobitz/NEONSoils: Compute Soil Carbon Fluxes for the National Ecological Observatory Network Sites

#' @title Determine if a YYYY-MM string is inside a interval

#' @author
#' John Zobitz \email{zobitz@augsburg.edu}

#'
#' @param start starting interval time
#' @param end  ending interval time
#' @param reference_time time we are comparing to - YYYY-MM string
#'
#' @return Logical indicating whether or not the reference time is inside the interval. We need this when working with downloaded NEON data which usually comes in a YYYY-MM string
#' @export

#' @examples
#' # Define starting and ending dates:
#' start_date <- as.POSIXct("2021-06-01 09:30:00",tz="UTC")
#' end_date <- as.POSIXct("2023-06-01 20:00:00",tz="UTC")
#'
#' # Test, should return TRUE
#' inside_interval(start_date,end_date,"2022-06")
#'
#' # Test, should return FALSE
#' inside_interval(start_date,end_date,"2020-06")




inside_interval <- function(start,end,reference_time) {

  # changelog and author contributions / copyrights
  #   John Zobitz (2024-04-10)
  #     original creation


  # First evaluate if the input vector times are valid time

  new_reference <- as.POSIXct(lubridate::ym(reference_time))

  new_start <- dplyr::if_else(!is.na(start),as.POSIXct(start),as.POSIXct(lubridate::today()) )
  new_end <- dplyr::if_else(!is.na(end),as.POSIXct(end),as.POSIXct(lubridate::today()) )

  out_val <- dplyr::between(new_reference,new_start,new_end)
  return(out_val)


}