Download Spatial Boundaries
Usage
download_boundaries(
surveyNum = NULL,
surveyId = NULL,
countryId = NULL,
method = "sf",
quiet_download = FALSE,
quiet_parse = TRUE,
server_sleep = 5
)
Arguments
- surveyNum
Numeric for the survey number to be downloaded. Values for surveyNum can be found in the datasets or surveys endpoints in the DHS API that can be accessed using
dhs_datasets
anddhs_surveys
. Default is NULL, which will cause the SurveyId to be used to find the survey.- surveyId
Numeric for the survey ID to be downloaded. Values for surveyId can be found in the datasets or surveys endpoints in the DHS API that can be accessed using
dhs_datasets
anddhs_surveys
. Default is NULL, which will cause the SurveyNum to be used to find the survey.- countryId
2-letter DHS country code for the country of the survey being downloaded. Default = NULL, which will cause the countrycode to be looked up from the API.
- method
Character for how the downloaded shape file is read in. Default = "sf", which uses
sf::st_read
. Currenlty, you can also specify "rgdal", which reads the file using rgdal::readOGR. To just return the file paths for the files use method = "zip".- quiet_download
Whether to download file quietly. Passed to [`download_file()`]. Default is `FALSE`.
- quiet_parse
Whether to read boundaries dataset quietly. Applies to `method = "sf"`. Default is `TRUE`.
- server_sleep
Numeric for length of sleep prior to downloading file from their survey. Default 5 seconds.
Value
Returns either the spatial file as a "SpatialPolygonsDataFrame" or a vector of the file paths of where the boundary was downloaded to.
Details
Downloads the spatial boundaries from the DHS spatial repository, which can be found at https://spatialdata.dhsprogram.com/home/.