{ "_id": "69b7ca3ba485b674afcff18c", "Package": "rdhs", "Type": "Package", "Title": "API Client and Dataset Management for the Demographic and Health\nSurvey (DHS) Data", "Version": "0.8.4", "Authors@R": "c(person(given = \"OJ\",\nfamily = \"Watson\",\nrole = c(\"aut\", \"cre\"),\nemail = \"oj.watson@hotmail.co.uk\",\ncomment = c(ORCID = \"0000-0003-2374-0741\")),\nperson(given = \"Jeff\",\nfamily = \"Eaton\",\nrole = \"aut\",\ncomment = c(ORCID = \"0000-0001-7728-728X\")),\nperson(given = \"Lucy\",\nfamily = \"D'Agostino McGowan\",\nrole = \"rev\",\ncomment = c(ORCID = \"0000-0001-7297-9359\")),\nperson(given = \"Duncan\",\nfamily = \"Gillespie\",\nrole = \"rev\"))", "Maintainer": "OJ Watson ", "URL": "https://docs.ropensci.org/rdhs/", "BugReports": "https://github.com/ropensci/rdhs/issues", "Description": "Provides a client for (1) querying the DHS API for survey\nindicators and metadata\n(), (2) identifying\nsurveys and datasets for analysis, (3) downloading survey\ndatasets from the DHS website, (4) loading datasets and\nassociate metadata into R, and (5) extracting variables and\ncombining datasets for pooled analysis.", "LazyData": "TRUE", "License": "MIT + file LICENSE", "RoxygenNote": "7.3.2", "VignetteBuilder": "knitr", "Language": "en-GB", "Encoding": "UTF-8", "Config/pak/sysreqs": "libabsl-dev cmake libgdal-dev gdal-bin libgeos-dev\nmake libicu-dev libxml2-dev libssl-dev libproj-dev\nlibsqlite3-dev libudunits2-dev libx11-dev zlib1g-dev", "Repository": "https://ropensci.r-universe.dev", "Date/Publication": "2025-02-27 15:28:59 UTC", "RemoteUrl": "https://github.com/ropensci/rdhs", "RemoteRef": "main", "RemoteSha": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "NeedsCompilation": "no", "Packaged": { "Date": "2026-03-16 09:12:08 UTC", "User": "root" }, "Author": "OJ Watson [aut, cre] (ORCID: ),\nJeff Eaton [aut] (ORCID: ),\nLucy D'Agostino McGowan [rev] (ORCID:\n),\nDuncan Gillespie [rev]", "MD5sum": "5bbb042a0bf04778cf57d2f8d0d452e4", "_user": "ropensci", "_type": "src", "_file": "rdhs_0.8.4.tar.gz", "_fileid": "05d6c9081244858cbab6e30f9ef0e09afbd4e30e9db05b90e8ab29cfb0064afe", "_filesize": 1188915, "_sha256": "05d6c9081244858cbab6e30f9ef0e09afbd4e30e9db05b90e8ab29cfb0064afe", "_created": "2026-03-16T09:12:08.000Z", "_published": "2026-03-16T09:15:39.349Z", "_distro": "noble", "_jobs": [ { "job": 67200382856, "time": 167, "config": "linux-devel-x86_64", "r": "4.6.0", "check": "OK", "artifact": "5940210741" }, { "job": 67200382920, "time": 156, "config": "linux-release-x86_64", "r": "4.5.3", "check": "OK", "artifact": "5940207937" }, { "job": 67200382891, "time": 120, "config": "macos-devel-arm64", "r": "4.6.0", "check": "OK", "artifact": "5940199385" }, { "job": 67200382870, "time": 93, "config": "macos-release-arm64", "r": "4.5.3", "check": "OK", "artifact": "5940193090" }, { "job": 67199926952, "time": 202, "config": "pkgdown", "r": "4.5.2", "check": "OK", "artifact": "5940161520" }, { "job": 67199927001, "time": 226, "config": "source", "r": "4.5.2", "check": "OK", "artifact": "5940167871" }, { "job": 67200382915, "time": 139, "config": "wasm-release", "r": "4.5.1", "check": "OK", "artifact": "5940203802" }, { "job": 67200382865, "time": 99, "config": "windows-devel", "r": "4.6.0", "check": "OK", "artifact": "5940194124" }, { "job": 67200382874, "time": 124, "config": "windows-oldrel", "r": "4.4.3", "check": "OK", "artifact": "5940200186" }, { "job": 67200382924, "time": 95, "config": "windows-release", "r": "4.5.3", "check": "OK", "artifact": "5940193517" } ], "_buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394", "_status": "success", "_host": "GitHub-Actions", "_upstream": "https://github.com/ropensci/rdhs", "_commit": { "id": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "author": "OJWatson ", "committer": "OJWatson ", "message": "function to allow user to set internal rdhs client\n", "time": 1740670139 }, "_maintainer": { "name": "OJ Watson", "email": "oj.watson@hotmail.co.uk", "login": "ojwatson", "uuid": 15249565, "orcid": "0000-0003-2374-0741" }, "_registered": true, "_dependencies": [ { "package": "R", "version": ">= 3.3.0", "role": "Depends" }, { "package": "brio", "role": "Imports" }, { "package": "R6", "role": "Imports" }, { "package": "httr", "role": "Imports" }, { "package": "jsonlite", "role": "Imports" }, { "package": "foreign", "role": "Imports" }, { "package": "magrittr", "role": "Imports" }, { "package": "rappdirs", "role": "Imports" }, { "package": "digest", "role": "Imports" }, { "package": "storr", "role": "Imports" }, { "package": "xml2", "role": "Imports" }, { "package": "qdapRegex", "role": "Imports" }, { "package": "getPass", "role": "Imports" }, { "package": "haven", "role": "Imports" }, { "package": "iotools", "role": "Imports" }, { "package": "sf", "role": "Imports" }, { "package": "cli", "role": "Imports" }, { "package": "rlang", "role": "Imports" }, { "package": "testthat", "role": "Suggests" }, { "package": "knitr", "role": "Suggests" }, { "package": "rmarkdown", "role": "Suggests" }, { "package": "ggplot2", "role": "Suggests" }, { "package": "survey", "role": "Suggests" }, { "package": "data.table", "role": "Suggests" }, { "package": "microbenchmark", "role": "Suggests" } ], "_owner": "ropensci", "_selfowned": true, "_usedby": 3, "_updates": [], "_tags": [], "_topics": [ "dataset", "dhs", "dhs-api", "extract", "peer-reviewed", "survey-data" ], "_stars": 38, "_contributors": [ { "user": "ojwatson", "count": 587, "uuid": 15249565 }, { "user": "jeffeaton", "count": 78, "uuid": 7427899 }, { "user": "richfitz", "count": 6, "uuid": 1558093 }, { "user": "lucymcgowan", "count": 2, "uuid": 8431897 }, { "user": "annakrystalli", "count": 1, "uuid": 5583057 }, { "user": "jeroen", "count": 1, "uuid": 216319 }, { "user": "maelle", "count": 1, "uuid": 8360597 }, { "user": "nickreich", "count": 1, "uuid": 1280767 } ], "_userbio": { "uuid": 1200269, "type": "organization", "name": "rOpenSci", "description": "Tools and R Packages for Open Science" }, "_downloads": { "count": 13168, "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/rdhs" }, "_mentions": 1, "_devurl": "https://github.com/ropensci/rdhs", "_pkgdown": "https://docs.ropensci.org/rdhs/", "_searchresults": 422, "_metadata": { "review": { "id": 238, "status": "reviewed", "version": "0.5.0", "organization": "rOpenSci Software Review", "url": "https://github.com/ropensci/software-review/issues/238" }, "ropensci_category": "data-access" }, "_rbuild": "4.5.2", "_assets": [ "extra/citation.cff", "extra/citation.html", "extra/citation.json", "extra/citation.txt", "extra/contents.json", "extra/NEWS.html", "extra/NEWS.txt", "extra/rdhs.html", "extra/readme.html", "extra/readme.md", "manual.pdf" ], "_homeurl": "https://github.com/ropensci/rdhs", "_realowner": "ropensci", "_cranurl": true, "_releases": [ { "version": "0.6.0", "date": "2018-12-18" }, { "version": "0.6.1", "date": "2019-01-24" }, { "version": "0.6.2", "date": "2019-03-04" }, { "version": "0.6.3", "date": "2019-03-19" }, { "version": "0.7.1", "date": "2020-12-01" }, { "version": "0.7.2", "date": "2021-04-28" }, { "version": "0.7.3", "date": "2021-07-19" }, { "version": "0.7.5", "date": "2022-09-29" }, { "version": "0.7.6", "date": "2022-10-20" }, { "version": "0.8.0", "date": "2023-10-10" }, { "version": "0.8.1", "date": "2023-11-21" } ], "_exports": [ "%>%", "as_factor.labelled", "client_dhs", "data_and_labels", "delabel_df", "dhs_countries", "dhs_data", "dhs_data_updates", "dhs_datasets", "dhs_geometry", "dhs_indicators", "dhs_info", "dhs_publications", "dhs_survey_characteristics", "dhs_surveys", "dhs_tags", "dhs_ui_updates", "download_boundaries", "extract_dhs", "get_available_datasets", "get_datasets", "get_downloaded_datasets", "get_rdhs_config", "get_variable_labels", "rbind_labelled", "read_dhs_dta", "read_zipdata", "search_variable_labels", "search_variables", "set_rdhs_config", "update_rdhs_config" ], "_datasets": [ { "name": "dhs_gps_data_format", "title": "DHS GPS Data Format", "object": "dhs_gps_data_format", "class": [ "data.frame" ], "fields": [ "Name", "Type", "Description" ], "rows": 20, "table": true, "tojson": true }, { "name": "model_datasets", "title": "DHS model datasets", "object": "model_datasets", "class": [ "data.frame" ], "fields": [ "FileFormat", "FileSize", "DatasetType", "SurveyNum", "SurveyId", "FileType", "FileDateLastModified", "SurveyYearLabel", "SurveyType", "SurveyYear", "DHS_CountryCode", "FileName", "CountryName", "URLS" ], "rows": 35, "table": true, "tojson": true } ], "_help": [ { "page": "as_factor.labelled", "title": "Archived dataset capable as_factor", "topics": [ "as_factor.labelled" ] }, { "page": "authenticate_dhs", "title": "DHS Website Authentication", "topics": [ "authenticate_dhs" ] }, { "page": "available_datasets", "title": "Create a data frame of datasets that your log in can download", "topics": [ "available_datasets" ] }, { "page": "client_cache_date", "title": "Pull last cache date", "topics": [ "client_cache_date" ] }, { "page": "client_dhs", "title": "Make a dhs client", "topics": [ "client_dhs" ] }, { "page": "collapse_api_responses", "title": "collapse API response list", "topics": [ "collapse_api_responses" ] }, { "page": "data_and_labels", "title": "Create list of dataset and its variable names", "topics": [ "data_and_labels" ] }, { "page": "delabel_df", "title": "convert labelled data frame to data frame of just characters", "topics": [ "delabel_df" ] }, { "page": "dhs_countries", "title": "API request of DHS Countries", "topics": [ "dhs_countries" ] }, { "page": "dhs_data", "title": "API request of DHS Indicator Data", "topics": [ "dhs_data" ] }, { "page": "dhs_data_updates", "title": "API request of DHS Data Updates", "topics": [ "dhs_data_updates" ] }, { "page": "dhs_datasets", "title": "API request of DHS Datasets", "topics": [ "dhs_datasets" ] }, { "page": "dhs_geometry", "title": "API request of DHS Geometry", "topics": [ "dhs_geometry" ] }, { "page": "dhs_gps_data_format", "title": "DHS GPS Data Format", "topics": [ "dhs_gps_data_format" ] }, { "page": "dhs_indicators", "title": "API request of DHS Indicators", "topics": [ "dhs_indicators" ] }, { "page": "dhs_info", "title": "API request of DHS Info", "topics": [ "dhs_info" ] }, { "page": "dhs_publications", "title": "API request of DHS Publications", "topics": [ "dhs_publications" ] }, { "page": "dhs_survey_characteristics", "title": "API request of DHS Survey Characteristics", "topics": [ "dhs_survey_characteristics" ] }, { "page": "dhs_surveys", "title": "API request of DHS Surveys", "topics": [ "dhs_surveys" ] }, { "page": "dhs_tags", "title": "API request of DHS Tags", "topics": [ "dhs_tags" ] }, { "page": "dhs_ui_updates", "title": "API request of DHS UI Updates", "topics": [ "dhs_ui_updates" ] }, { "page": "download_boundaries", "title": "DHS Spatial Boundaries", "topics": [ "download_boundaries" ] }, { "page": "download_datasets", "title": "Create a data frame of datasets that your log in can download", "topics": [ "download_datasets" ] }, { "page": "extract_dhs", "title": "Extract Data", "topics": [ "extract_dhs" ] }, { "page": "extraction", "title": "DHS survey questions extracted from datasets", "topics": [ "extraction" ] }, { "page": "factor_format", "title": "reformat haven and labelled read ins to have no factors or labels", "topics": [ "factor_format" ] }, { "page": "file_dataset_format", "title": "Returns what the dataset file ending should be for a given filename", "topics": [ "file_dataset_format" ] }, { "page": "get_available_datasets", "title": "Get Available Datasets", "topics": [ "get_available_datasets" ] }, { "page": "get_datasets", "title": "Get Datasets", "topics": [ "get_datasets" ] }, { "page": "get_downloaded_datasets", "title": "Get Downloaded Datasets", "topics": [ "get_downloaded_datasets" ] }, { "page": "get_labels_from_dataset", "title": "Return variable labels from a dataset", "topics": [ "get_labels_from_dataset" ] }, { "page": "get_rdhs_config", "title": "Get rdhs config", "topics": [ "get_rdhs_config" ] }, { "page": "get_variable_labels", "title": "Get Survey Variable Labels", "topics": [ "get_variable_labels" ] }, { "page": "last_api_update", "title": "Pull last DHS API database update time", "topics": [ "last_api_update" ] }, { "page": "model_datasets", "title": "DHS model datasets", "topics": [ "model_datasets" ] }, { "page": "parse_map", "title": "Create dictionary from DHS .MAP codebook", "topics": [ "parse_map" ] }, { "page": "parse_meta", "title": "Parse fixed-width file metadata", "topics": [ "parse_dcf", "parse_do", "parse_meta", "parse_sps" ] }, { "page": "rbind_labelled", "title": "Combine data frames with columns of class `labelled`", "topics": [ "rbind_labelled" ] }, { "page": "rbind_list_base", "title": "implementation of data.tables rbindlist", "topics": [ "rbind_list_base" ] }, { "page": "rdhs", "title": "'rdhs' DHS database through R", "topics": [ "rdhs-package", "rdhs" ] }, { "page": "read_dhs_dataset", "title": "read in dhs standard file types", "topics": [ "read_dhs_dataset" ] }, { "page": "read_dhs_dta", "title": "Read DHS Stata data set", "topics": [ "read_dhs_dta" ] }, { "page": "read_dhs_flat", "title": "Read DHS flat file data set", "topics": [ "read_dhs_flat" ] }, { "page": "read_zipdata", "title": "Read filetype from a zipped folder based on the file ending", "topics": [ "read_zipdata" ] }, { "page": "response_is_json", "title": "checks if the response is json or not by looking at the responses headers", "topics": [ "response_is_json" ] }, { "page": "response_to_json", "title": "converts response to json by first converting the response to text", "topics": [ "response_to_json" ] }, { "page": "search_variable_labels", "title": "Search Survey Variable Definitions", "topics": [ "search_variable_labels" ] }, { "page": "search_variables", "title": "Search Survey Variables", "topics": [ "search_variables" ] }, { "page": "set_rdhs_config", "title": "Set rdhs config", "topics": [ "set_rdhs_config" ] }, { "page": "unzip_special", "title": "unzip special that catches for 4GB+", "topics": [ "unzip_special" ] }, { "page": "update_rdhs_config", "title": "Update your current rdhs config", "topics": [ "update_rdhs_config" ] } ], "_readme": "https://github.com/ropensci/rdhs/raw/main/README.md", "_rundeps": [ "askpass", "bit", "bit64", "brio", "class", "classInt", "cli", "clipr", "cpp11", "crayon", "curl", "DBI", "digest", "e1071", "forcats", "foreign", "getPass", "glue", "haven", "hms", "httr", "iotools", "jsonlite", "KernSmooth", "lifecycle", "magrittr", "MASS", "mime", "openssl", "pillar", "pkgconfig", "prettyunits", "progress", "proxy", "qdapRegex", "R6", "rappdirs", "Rcpp", "readr", "rlang", "rstudioapi", "s2", "sf", "storr", "stringi", "sys", "tibble", "tidyselect", "tzdb", "units", "utf8", "vctrs", "vroom", "withr", "wk", "xml2" ], "_vignettes": [ { "source": "anemia.Rmd", "filename": "anemia.html", "title": "Anemia prevalence: an rdhs example", "author": "OJ Watson, Jeff Eaton", "engine": "knitr::rmarkdown", "headings": [ "Setup", "Using calculated indicators from STATcompiler", "Analyse DHS microdata", "Identify surveys that include anemia testing", "Download datasets", "Identify survey variables", "Extract survey data", "Data tabulations", "Calculate anemia prevalence", "Regression analysis: relationship between education and anemia" ], "created": "2018-04-11 17:29:36", "modified": "2023-10-10 21:01:17", "commits": 13 }, { "source": "country_codes.Rmd", "filename": "country_codes.html", "title": "Country Names and Codes", "author": "OJ Watson", "engine": "knitr::rmarkdown", "headings": [ "Overview" ], "created": "2018-11-12 18:51:58", "modified": "2018-11-12 18:51:58", "commits": 1 }, { "source": "boundaries.Rmd", "filename": "boundaries.html", "title": "Downloading Shape Files for DHS Surveys", "author": "OJ Watson", "engine": "knitr::rmarkdown", "headings": [ "Overview" ], "created": "2020-03-20 19:34:49", "modified": "2023-10-10 21:01:17", "commits": 2 }, { "source": "introduction.Rmd", "filename": "introduction.html", "title": "How to use rdhs?", "author": "OJ Watson, Jeff Eaton", "engine": "knitr::rmarkdown", "headings": [ "Overview", "0. Installation", "1. Access standard indicator data via the API", "2. Identify surveys relevant for further analysis", "3. Download survey datasets", "4. Load datasets and associated metadata into R.", "5. Extract variables and combining datasets for pooled multi-survey analyses.", "Summary and further thoughts" ], "created": "2018-04-11 17:29:36", "modified": "2023-10-10 21:01:17", "commits": 23 }, { "source": "geojson.Rmd", "filename": "geojson.html", "title": "Interacting with geojson API returns", "author": "OJ Watson", "engine": "knitr::rmarkdown", "headings": [ "Overview" ], "created": "2018-09-28 11:10:59", "modified": "2018-09-28 11:10:59", "commits": 1 }, { "source": "testing.Rmd", "filename": "testing.html", "title": "Running test suite locally", "author": "OJ Watson", "engine": "knitr::rmarkdown", "headings": [ "Overview", "1. Creating an account with the DHS website", "2. Setting up your rdhs config" ], "created": "2018-07-27 14:38:03", "modified": "2019-01-24 18:16:51", "commits": 4 }, { "source": "toolkit.Rmd", "filename": "toolkit.html", "title": "Toolkit", "author": "OJ Watson", "engine": "knitr::rmarkdown", "headings": [ "Overview" ], "created": "2018-04-18 18:13:42", "modified": "2021-04-28 21:01:45", "commits": 6 }, { "source": "client.Rmd", "filename": "client.html", "title": "rdhs client object and internal package design", "author": "OJ Watson, Jeff Eaton", "engine": "knitr::rmarkdown", "headings": [ "Overview", "0. Installation", "1. Access standard indicator data via the API", "2. Identify surveys relevant for further analysis", "3. Download survey datasets", "4. Load datasets and associated metadata into R.", "5. Extract variables and combining datasets for pooled multi-survey analyses.", "Summary and further thoughts" ], "created": "2018-04-23 19:25:12", "modified": "2023-10-10 21:01:17", "commits": 8 } ], "_score": 10.726016406228222, "_indexed": true, "_nocasepkg": "rdhs", "_universes": [ "ropensci", "ojwatson" ], "_binaries": [ { "r": "4.6.0", "os": "linux", "version": "0.8.4", "date": "2026-03-16T09:14:47.000Z", "distro": "noble", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "fb04bb73aeecba0a9d83c21f9814c54830dd840fe30f814bebb64265bbee96de", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" }, { "r": "4.5.3", "os": "linux", "version": "0.8.4", "date": "2026-03-16T09:14:42.000Z", "distro": "noble", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "b9c1577c945e84ff502aea2e64b59978778a3fe672cb98c12ecf349eea116d8c", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" }, { "r": "4.6.0", "os": "mac", "version": "0.8.4", "date": "2026-03-16T09:14:07.000Z", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "f02a4943e1bef73b4fb153c939e506b3ff494d35aa012e17ea1ce4bf717b5a0f", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" }, { "r": "4.5.3", "os": "mac", "version": "0.8.4", "date": "2026-03-16T09:13:47.000Z", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "46b5a7b77571b800f7f63b148d65fb661ed21fce0acea19f0fc07bac111ddb99", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" }, { "r": "4.5.1", "os": "wasm", "version": "0.8.4", "date": "2026-03-16T09:14:48.000Z", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "1bb4c5d3838b4fe44a14160757645fc6c079bcb1851d8732255b86b06fbc5b88", "status": "success", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" }, { "r": "4.6.0", "os": "win", "version": "0.8.4", "date": "2026-03-16T09:13:34.000Z", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "8c85baa4e9711f3e9f77fde836588bed2ee965f1f5a950d2ae6d5455601719e1", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" }, { "r": "4.5.3", "os": "win", "version": "0.8.4", "date": "2026-03-16T09:13:31.000Z", "commit": "a1e1b864c52d0a30825be182bc3bb64de3c2ce4b", "fileid": "180722f56029ef2fa52fc9aca2e84fc2fada6aefa3acf3a2eeb29d1df7fa3253", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/ropensci/actions/runs/23135981394" } ] }