update docs_questionnaire long and short

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: censobr
 Title: Download Data from Brazil's Population Census
-Version: 0.2.0999
+Version: 0.2.9999
 Authors@R: 
     c(person(given="Rafael H. M.", family="Pereira", 
              email="rafa.pereira.br@gmail.com", 

NEWS.md

@@ -1,4 +1,7 @@
-# censobr v0.2.0999
+# censobr v0.2.9999
+
+* Major changes
+  * The `questionnaire()` function now accepts questionnaires of `type`: `"long"` or `"short"`.
 
 * Minor changes
   * Replaced `.onAttach` by `.onLoad` so that the package works with `censobr::function()`

R/docs_questionnaire.R

@@ -5,9 +5,10 @@
 #' censuses
 #'
 #' @template year
-#' @param type Character. The type of questionnaire, whether the one used in the
-#'        sample component of the census, or on the universe component. Options
-#'        currently include `c("sample")`.
+#' @param type Character. The type of questionnaire used in the survey, whether
+#'        the `"long"` one used in the sample component of the census, or the
+#'        `"short"` one, which is answered by more households. Options currently
+#'        include `c("long")`.
 #' @template showProgress
 #' @template cache
 #'
@@ -18,14 +19,14 @@
 #' library(censobr)
 #'
 #' # Open questionnaire on browser
-#' questionnaire(year = 2010, type = 'sample', showProgress = FALSE)
+#' questionnaire(year = 2010, type = 'long', showProgress = FALSE)
 #'
 questionnaire <- function(year = 2010,
                           type = NULL,
                           showProgress = TRUE,
                           cache = TRUE){
   # year = 2010
-  # type = 'sample'
+  # type = 'long'
 
   ### check inputs
   checkmate::assert_numeric(year)
@@ -38,7 +39,7 @@ questionnaire <- function(year = 2010,
                                         )}
 
   # data available for data sets:
-  data_sets <- c('sample')
+  data_sets <- c('long')
   if (isFALSE(type %in% data_sets)) { stop( paste0("Error: Questionnaire currently only available for the types: ",
                                               paste(data_sets, collapse = ", "))
                                             )}

cran-comments.md

@@ -1,11 +1,14 @@
 ## R CMD check results
 
-── R CMD check results ────────────────────────────────── censobr 0.2.1 ────
-Duration: 17m 12s
+── R CMD check results ───────────────────────────────────────────── censobr 0.2.0999 ────
+Duration: 21m 10.4s
 
 0 errors ✔ | 0 warnings ✔ | 0 notes ✔
 
-
 * Minor changes
   * Replaced `.onAttach` by `.onLoad` so that the package works with `censobr::function()`
-  * Fixed documentation of `read_tracts()`.
+  * Fixed documentation of various functions.
+
+* Data included in this version:
+  * 2022 census [*New*]
+    * Questionnaires and interview manuals 

tests/testthat/test_docs_questionnaire.R

@@ -5,17 +5,17 @@ skip_if(Sys.getenv("TEST_ONE") != "")
 testthat::skip_on_cran()
 
 
-# Reading the data -----------------------
+# Reading long questionnaire -----------------------
 
 test_that("questionnaire", {
 
   # download files
-  testthat::expect_message( questionnaire(year = 2022, type = 'sample') )
-  testthat::expect_message( questionnaire(year = 2010, type = 'sample') )
-  testthat::expect_message( questionnaire(year = 2000, type = 'sample') )
-  testthat::expect_message( questionnaire(year = 1991, type = 'sample') )
-  testthat::expect_message( questionnaire(year = 1980, type = 'sample') )
-  testthat::expect_message( questionnaire(year = 1970, type = 'sample') )
+  testthat::expect_message( questionnaire(year = 2022, type = 'long') )
+  testthat::expect_message( questionnaire(year = 2010, type = 'long') )
+  testthat::expect_message( questionnaire(year = 2000, type = 'long') )
+  testthat::expect_message( questionnaire(year = 1991, type = 'long') )
+  testthat::expect_message( questionnaire(year = 1980, type = 'long') )
+  testthat::expect_message( questionnaire(year = 1970, type = 'long') )
 
   # cache dir
   pkgv <- paste0('censobr/data_release_', data_release)
@@ -25,13 +25,43 @@ test_that("questionnaire", {
   years <- c(1970, 1980, 1991, 2000, 2010, 2022)
 
   lapply(X=years, FUN = function(y){
-    f_address <- paste0(cache_dir,'/',y, '_questionnaire_sample.pdf')
+    f_address <- paste0(cache_dir,'/',y, '_questionnaire_long.pdf')
     testthat::expect_true(file.exists(f_address))
     } )
 
  })
 
 
+
+
+
+# # Reading short questionnaire -----------------------
+#
+# test_that("questionnaire", {
+#
+#   # download files
+#   testthat::expect_message( questionnaire(year = 2022, type = 'short') )
+#   testthat::expect_message( questionnaire(year = 2010, type = 'short') )
+#   testthat::expect_message( questionnaire(year = 2000, type = 'short') )
+#   testthat::expect_message( questionnaire(year = 1991, type = 'short') )
+#   testthat::expect_message( questionnaire(year = 1980, type = 'short') )
+#   testthat::expect_message( questionnaire(year = 1970, type = 'short') )
+#
+#   # cache dir
+#   pkgv <- paste0('censobr/data_release_', data_release)
+#   cache_dir <- tools::R_user_dir(pkgv, which = 'cache')
+#
+#   ## check if file have been downloaded
+#   years <- c(1970, 1980, 1991, 2000, 2010, 2022)
+#
+#   lapply(X=years, FUN = function(y){
+#     f_address <- paste0(cache_dir,'/',y, '_questionnaire_short.pdf')
+#     testthat::expect_true(file.exists(f_address))
+#   } )
+#
+# })
+
+
 # ERRORS and messages  -----------------------
 test_that("questionnaire", {