Merge pull request #22 from kuriwaki/cumulative2024

Cumulative 2024 link update

Author: kuriwaki

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: ccesMRPprep
 Type: Package
 Title: Functions and Data to Prepare CCES data for MRP
-Version: 0.1.13
+Version: 0.1.14
 Authors@R: 
    c(person(given = "Shiro",
              family = "Kuriwaki",

R/get_dataverse.R

@@ -1,11 +1,9 @@
 #' Download a specific CCES dataset from dataverse, with some indexing
 #'
-#' Get the data from dataverse into the current R environment. You must use
-#' the development version of [IQSS/dataverse-client-r](https://github.com/IQSS/dataverse-client-r).
-#' The function also does
+#' Wrapper function to get CCES/CES data from dataverse into the current R environment using the `dataverse` package.
 #'
 #'
-#' @param name The name of the dataset as defined in \code{data(cces_dv_ids)}.
+#' @param name The name of the dataset as defined in \code{data(cces_dv_ids)}. e.g. `"cumulative"` or `"2018"`.
 #' @param year_subset The year (or years, a vector) to subset too. If `name` is a year
 #' specific dataset, this argument is redundant, but if `name == "cumulative"`, then
 #' the output will be the cumulative dataset subsetted to that year. This is useful
@@ -19,12 +17,19 @@
 #' CCES dataset. Built-in data \link{cces_dv_ids} is used as a default and should
 #' not be changed.
 #'
-#' @details The current dataverse package downloads the raw data, so this function writes
-#' the raw binary into a tempfile and loads it into a tibble with the appropriate
-#' file data type. We find it convenient to loop over this function for all values in
-#' \link{cces_dv_ids} and populate the MRP directory with all datasets (about 2GB
-#' in total). Each dataset has slightly different formats; using \link{get_cces_question}
-#' will standardize, for example, the name of the case ID.
+#' @details This function is a simple wrapper around the `dataverse` pacakge on CRAN.
+#' It downloads the dataset from the dataverse, and loads it into a tibble with the appropriate
+#' file data type.  Using \link{get_cces_question} does some standardization across years, for example,
+#' the name of the case ID variable, so that it makes downstream.
+#' As of v0.3.15, `dataverse` accepts a cache by default if you specify a dataverse version.
+#' `get_cces_dataverse` does not specify a version and simplify re-downloads whatever
+#' is the latest version of the dataset on dataverse at the time, it does not support caching.
+
+#' You may be interested in customizing your download following  <https://cran.r-project.org/web/packages/dataverse/vignettes/C-download.html>,
+#' or downloading the feather version of the CCES cumulative, which reads much
+#' faster than the default .dta file in this function.
+#'
+#'
 #'
 #' @importFrom glue glue
 #' @importFrom stringr str_extract
@@ -36,6 +41,8 @@
 #' @importFrom rlang sym `!!` .data
 #' @importFrom dataverse get_file get_dataframe_by_name
 #'
+#' @seealso [ccc_std_demographics()] [cces_dv_ids]
+#'
 #' @examples
 #'
 #' # read in cumulative common content, subsetted to 2018, into environemt

data-raw/create_dataverse-ids.R

@@ -2,7 +2,7 @@ library(tibble)
 
 cces_dv_ids <- tribble(
   ~cces_name, ~year, ~doi, ~filename,  ~caseid_var, ~server,
-  "cumulative", NA,   "10.7910/DVN/II2DB6", "cumulative_2006-2023.dta", "case_id", "dataverse.harvard.edu",
+  "cumulative", NA,   "10.7910/DVN/II2DB6", "cumulative_2006-2024.dta", "case_id", "dataverse.harvard.edu",
   "2006",       2006, "10.7910/DVN/Q8HC9N", "cces_2006_common.tab", "v1000",   "dataverse.harvard.edu",
   "2007",       2007, "10.7910/DVN/OOXTJ5", "CCES07_OUTPUT.sav", "caseid",  "dataverse.harvard.edu",
   "2008",       2008, "10.7910/DVN/YUYIVB", "cces_2008_common.tab", "V100",    "dataverse.harvard.edu",