R/docs_interview_manual.R

In censobr: Download Data from Brazil's Population Census

#' Interview manual of the data collection of Brazil's censuses
#'
#' @description
#' Open on a browser the interview manual of the data collection of Brazil's
#' censuses
#'
#' @template year
#' @template showProgress
#' @template cache
#' @template verbose
#'
#' @return Opens a `.pdf` file on the browser
#' @export
#' @family Census documentation
#' @examplesIf identical(tolower(Sys.getenv("NOT_CRAN")), "true")
#' # Open interview manual on the browser
#' interview_manual(
#'   year = 2010,
#'   showProgress = FALSE
#'   )
#'
interview_manual <- function(year = NULL,
                             showProgress = TRUE,
                             cache = TRUE,
                             verbose = TRUE){
  # year = 2000

  ### check inputs
  checkmate::assert_numeric(year)
  checkmate::assert_logical(verbose)

  # data available for the years:
  years <- c(1960, 1970, 1980, 1991, 2000, 2010, 2022)
  if (isFALSE(year %in% years)) {
    years_available <- paste(years, collapse = " ")
    cli::cli_abort(
      "Interview manual currently only available for the years {years_available}.",
      call = rlang::caller_env()
    )
  }

  ### Get url
  fname <- paste0(year, '_interview_manual.pdf')
  file_url <- paste0("https://github.com/ipeaGIT/censobr/releases/download/censo_docs/", fname)

  ### Download
  local_file <- download_file(file_url = file_url,
                              showProgress = showProgress,
                              cache = cache,
                              verbose = verbose)

  # check if download worked
  if(is.null(local_file)) { return(NULL) }

  # open data dic on browser
  utils::browseURL(url = local_file)
}