Add DHS API support

NEWS.md

@@ -1,7 +1,15 @@
 # ipumsr (development version)
 
-* Improved parsing of labeled values included in "codInstr" tags in the DDI 
-  codebook for microdata extracts.
+## New features
+
+* Added API support for IPUMS DHS (`"dhs"`). DHS extracts can now be defined,
+  submitted, and downloaded via the IPUMS API using the same workflow as other
+  microdata collections.
+
+## Bug fixes
+
+* Improved parsing of labeled values included in "codInstr" tags in the DDI
+  codebook for microdata extracts (#94).
 
 # ipumsr 0.9.0
 

R/api_define_extract.R

@@ -96,6 +96,7 @@ NULL
 #'   + [IPUMS USA](https://usa.ipums.org/)
 #'   + [IPUMS CPS](https://cps.ipums.org/)
 #'   + [IPUMS International](https://international.ipums.org/)
+#'   + [IPUMS DHS](https://www.idhsdata.org/idhs/)
 #'   + IPUMS Time Use ([ATUS](https://www.atusdata.org/atus/), [AHTUS](https://www.ahtusdata.org/ahtus/), [MTUS](https://www.mtusdata.org/mtus/))
 #'   + IPUMS Health Surveys ([NHIS](https://nhis.ipums.org/), [MEPS](https://meps.ipums.org/))
 #'

R/api_helpers.R

@@ -18,6 +18,7 @@
 #' * IPUMS International (`"ipumsi"`)
 #' * IPUMS Time Use (`"atus"`, `"ahtus"`, `"mtus"`)
 #' * IPUMS Health Surveys (`"nhis"`, `"meps"`)
+#' * IPUMS DHS (`"dhs"`)
 #' * IPUMS NHGIS (`"nhgis"`)
 #' * IPUMS IHGIS (`"ihgis"`)
 #'

R/api_metadata.R

@@ -264,6 +264,7 @@ get_metadata <- function(collection,
 #' get_sample_info("ipumsi")
 #' get_sample_info("atus")
 #' get_sample_info("meps")
+#' get_sample_info("dhs")
 #' }
 get_sample_info <- function(collection = NULL,
                             delay = 0,
@@ -291,7 +292,8 @@ catalog_types <- function(collection) {
     "ahtus" = "samples",
     "mtus" = "samples",
     "nhis" = "samples",
-    "meps" = "samples"
+    "meps" = "samples",
+    "dhs" = "samples"
   )
 
   endpts[[collection]]

R/proj_config.R

@@ -117,6 +117,7 @@ proj_config <- function() {
       url_name = "idhs",
       collection_type = "microdata",
       code_for_api = "dhs",
+      api_support = TRUE,
       home_url = "https://www.idhsdata.org/",
       var_url = function(var = "group") {
         get_var_url("idhsdata", "idhs", var = var, ipums_domain = FALSE)

README.Rmd

@@ -162,7 +162,7 @@ tbl_config <- list(
       "and <a href='https://pma.ipums.org/'>Performance Monitoring for Action (PMA)</a> surveys"
     ),
     read = checkmark(),
-    request = "",
+    request = "DHS only",
     metadata = ""
   ),
   list(