R/check_args.R

In essurvey: Download Data from the European Social Survey on the Fly

## TODO
## Properly document these functions if you want to export them.
## Think about it or ask in the issues?
check_rounds <- function(rounds) { # nocov start
  all_rounds_present <- rounds %in% show_rounds()

  if (!all(all_rounds_present))  {

    failed_rounds <- paste0(rounds[!all_rounds_present], collapse = ", ")

    stop(
      paste("ESS round", failed_rounds,
            "is not available. Check show_rounds()")
    )
  }

  TRUE
} # nocov end

check_country <- function(country) { # nocov start

  if (length(country) > 1) stop("Argument `country` should only contain one country")

  all_countries_present <- country %in% show_countries()


  if (!all(all_countries_present))  {

    failed_countries <- paste0(country[!all_countries_present], collapse = ", ")

    stop(
      paste("Country", failed_countries,
            "not available in ESS. Check show_countries()",
            collapse = "\n")
    )
  }

  TRUE
} # nocov end


check_country_rounds <- function(country, rounds) { # nocov start

  check_country(country)

  all_rounds_present <- rounds %in% show_country_rounds(country)

  if (!all(all_rounds_present))  {

    failed_rounds <- paste0(rounds[!all_rounds_present], collapse = ", ")

    stop(
      paste0("ESS round ", failed_rounds,
            " not available for ", country,
            ". Check show_country_rounds('", country, "')")
    )
  }

  TRUE
} # nocov end

check_country_sddf_rounds <- function(country, rounds) { # nocov start

  check_country(country)

  all_rounds_present <- rounds %in% show_sddf_cntrounds(country)

  if (!all(all_rounds_present))  {

    failed_rounds <- paste0(rounds[!all_rounds_present], collapse = ", ")

    stop(
      paste0("ESS round ", failed_rounds,
             ifelse(length(all_rounds_present) > 1, " don't", " doesn't"),
             " have SDDF data available for ", country,
            ". Check show_sddf_cntrounds('", country, "')")
    )
  }

  TRUE
} # nocov end

check_theme <- function(theme) { # nocov start

  if (length(theme) > 1) stop("Argument `theme` should only contain one theme")

  all_theme_present <- theme %in% show_themes()

  if (!all(all_theme_present))  {

    stop(
      paste0("ESS theme ", theme, " not available. Check show_themes()")
    )
  }

  TRUE
} # nocov end

validate_arguments <- function(country, round) {
  stopifnot(is.character(country), length(country) > 0)
  stopifnot(is.character(round), length(round) > 0)
}