R/check_os.R

Defines functions check_os

Documented in check_os

#' Checks if the operating system is supported
#' @inheritParams default_params_doc
#' @return Nothing. Will \link{stop} if the OS is unsupported
#' @author Richèl J.C. Bilderbeek
#' @examples
#' check_empty_beaustier_folders()
#'
#' check_os("mac")
#' check_os("unix")
#' check_os("win")
#'
#' check_empty_beaustier_folders()
#' @export
check_os <- function(os) {
  if (!os %in% c("mac", "unix", "win")) {
    stop("'os' must be either 'mac', 'unix' or 'win'")
  }
}
richelbilderbeek/beastier documentation built on Sept. 7, 2024, 2:15 a.m.