available_datasets: Create a data frame of datasets that your log in can download

View source: R/authentication.R

available_datasetsR Documentation

Create a data frame of datasets that your log in can download

Description

DHS datasets that can be downloaded

Usage

available_datasets(
  config,
  datasets_api_results = NULL,
  surveys_api_results = NULL
)

Arguments

config

Object of class 'rdhs_config' as produced by 'read_rdhs_config' that must contain a valid 'email', 'project' and 'password'.

datasets_api_results

Data.table for the api results for the datasets endpoint. Default = NULL and generated by default if not declared.

surveys_api_results

Data.table for the api results for the surveys endpoint. Default = NULL and generated by default if not declared.

Value

Returns "data.frame" of length 14:

  • "FileFormat"

  • "FileSize"

  • "DatasetType"

  • "SurveyNum"

  • "SurveyId"

  • "FileType"

  • "FileDateLastModified"

  • "SurveyYearLabel"

  • "SurveyType"

  • "SurveyYear"

  • "DHS_CountryCode"

  • "FileName"

  • "CountryName"

  • "URLS"

Note

Inspiration for function to https://github.com/ajdamico/lodown/blob/master/R/dhs.R


rdhs documentation built on Nov. 21, 2023, 5:07 p.m.