R/check_vocabs.R

In ices-tools-prod/icesVMS: Link to the ICES Vessel Monitoring System and Logbook Database Web Services

#' Lists of Vocabularies
#'
#' Get a list of vocabularies such as country codes or ecoregions.
#'
#' @param arg one of country code, ICES statistical rectangle or ICES ecoregion
#' @param stop.on.fail logical, if TRUE function will call stop() 
#' 
#' @return logical
#'
#' @examples
#' \donttest{
#' check_ecoregion("Celtic Seas")
#'
#' check_stat_recs("40F1")
#'
#' check_countries("DK")
#' check_countries(c("DK", "GB"))
#' }
#' @importFrom icesVocab getCodeList
#'
#' @rdname checkVocabLists
#' @export
check_ecoregion <- function(arg, stop.on.fail = TRUE) {
  ok <- all(arg %in% get_ecoregion_list())
  
  if (!ok && stop.on.fail) {
    stop("ecoregion is not valid. For valid options see: \n\nget_ecoregion_list()")
  }

  ok
}

#' @rdname checkVocabLists
#' @export
check_stat_recs <- function(arg, stop.on.fail = TRUE) {
  ok <- all(arg %in% get_stat_rec_list())

  if (!ok && stop.on.fail) {
    stop("stat_rec is not valid. For valid options see: \n\nget_stat_rec_list()")
  }

  ok
}

#' @rdname checkVocabLists
#' @export
check_countries <- function(arg, stop.on.fail = TRUE) {
  ok <- all(arg %in% get_country_list())

  if (!ok && stop.on.fail) {
    stop("country is not valid. For valid options see: \n\n get_country_list()")
  }

  ok
}