_pkgdown.yml

url: https://docs.ropensci.org/rdhs/

template:
  params:
    bootswatch: flatly

reference:
  - title: "Query DHS API"
    desc: "Functions for interacting with each of the DHS API endpoints. They all start 'dhs_' for simplicity."
    contents:
      - 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

  - title: "Set up DHS login credentials"
    desc: >
      "Set our credentials for logging into the DHS website. This creates in the backend a rdhs client for
      downloading datasets, querying survey variables and extracting data."
    contents:
      - set_rdhs_config
      - get_rdhs_config
      - update_rdhs_config
      - client_dhs

  - title: "User Interface"
    desc: "Functions to download, search and interact with downloaded datasets"
    contents:
      - extract_dhs
      - get_available_datasets
      - get_datasets
      - get_downloaded_datasets
      - search_variables
      - search_variable_labels
      - download_boundaries

  - title: "Downstream Dataset Helper Functions"
    desc: Tools to help combine extracted datasets, as well as extract and apend dataset variable names and definitions
    contents:
      - rbind_labelled
      - get_variable_labels
      - data_and_labels
      - delabel_df

  - title: "DHS Dataset Parsers"
    desc: "Custom built parsers for handling flat ASCII and stata DHS datasets"
    contents:
      - read_dhs_flat
      - parse_dcf
      - parse_do
      - parse_sps
      - read_dhs_dta

  - title: "internal"
    desc: "Internal Functions"
    contents:
      - as_factor.labelled
      - authenticate_dhs
      - available_datasets
      - client_cache_date
      - collapse_api_responses
      - dhs_gps_data_format
      - download_datasets
      - extraction
      - factor_format
      - file_dataset_format
      - get_labels_from_dataset
      - last_api_update
      - model_datasets
      - parse_map
      - rbind_list_base
      - rdhs
      - read_dhs_dataset
      - read_zipdata
      - response_is_json
      - response_to_json
      - unzip_special