Skip to contents

Retrieve IDP data at Admin 1 level based on specified parameters. At least one of the following parameters must be provided: operation, admin0_name, or admin0_pcode.

Usage

baseline_get_admin1(
  operation = NULL,
  admin0_name = NULL,
  admin0_pcode = NULL,
  admin1_name = NULL,
  admin1_pcode = NULL,
  from_reporting_date = NULL,
  to_reporting_date = NULL,
  from_round_number = NULL,
  to_round_number = NULL
)

Arguments

operation

Optional; Name of the DTM operation for which the data was collected.

admin0_name

Optional; Name of the country where the data was collected.

admin0_pcode

Optional; Country code (ISO 3166-1 alpha-3).

admin1_name

Optional; Name of level 1 administrative boundaries.

admin1_pcode

Optional; Place code of level 1 administrative boundaries.

from_reporting_date

Optional; Start date for the reporting period (format: 'YYYY-MM-DD').

to_reporting_date

Optional; End date for the reporting period (format: 'YYYY-MM-DD').

from_round_number

Optional; Starting round number for the data collection range.

to_round_number

Optional; Ending round number for the data collection range.

Value

A data frame containing the IDP Admin1 data matching the specified criteria.

Examples

if (FALSE) { # !identical(Sys.getenv("BASELINE_DTM_SUBSCRIPTION_KEY"), "")
# Fetch IDP data at Admin Level 1
idp_admin1_df <- baseline_get_admin1(
   admin0_name = "Sudan",
   from_reporting_date = "2020-01-01",
   to_reporting_date = "2024-08-15"
)
head(idp_admin1_df)
}