R/shopr_clean_fulfillment_status.R

Defines functions shopr_clean_fulfillment_status

Documented in shopr_clean_fulfillment_status

#' Clean fulfillment status
#'
#' Helper function to validate and clean fulfillment status parameter
#'
#' @param fulfillment_status one of {'any', 'shipped', 'partial', 'unshipped'}
#' @return string of clean financial_status

shopr_clean_fulfillment_status <- function(fulfillment_status){

  if(is.null(fulfillment_status)){
    return(NULL)
  } else{
    fulfillment_statuses <- c("any", "shipped", "partial", "unshipped")
    if(!fulfillment_status %in% fulfillment_statuses){
      stop(paste0(
        "fulfillment_status = '", fulfillment_status, "', is not one of the allowed values {",
        paste(fulfillment_status, collapse = ','), "}"
      ))
    } else{
      return(fulfillment_status)
    }
  }
}
GormAnalysis/shopr documentation built on Jan. 10, 2022, 1:42 a.m.