get_idp_admin2_data {dtmapi} | R Documentation |
Retrieve IDP data at Admin 2 level based on specified parameters. At least one of the following parameters must be provided: Operation, CountryName, or Admin0Pcode.
get_idp_admin2_data(
Operation = NULL,
CountryName = NULL,
Admin0Pcode = NULL,
Admin1Name = NULL,
Admin1Pcode = NULL,
Admin2Name = NULL,
Admin2Pcode = NULL,
FromReportingDate = NULL,
ToReportingDate = NULL,
FromRoundNumber = 0,
ToRoundNumber = 0
)
Operation |
Optional; Name of the DTM operation for which the data was collected. |
CountryName |
Optional; Name of the country where the data was collected. |
Admin0Pcode |
Optional; Country code (ISO 3166-1 alpha-3). |
Admin1Name |
Optional; Name of level 1 administrative boundaries. |
Admin1Pcode |
Optional; Place code of level 1 administrative boundaries. |
Admin2Name |
Optional; Name of level 2 administrative boundaries. |
Admin2Pcode |
Optional; Place code of level 2 administrative boundaries. |
FromReportingDate |
Optional; Start date for the reporting period (format: 'YYYY-MM-DD'). |
ToReportingDate |
Optional; End date for the reporting period (format: 'YYYY-MM-DD'). |
FromRoundNumber |
Optional; Starting round number for the data collection range. |
ToRoundNumber |
Optional; Ending round number for the data collection range. |
A data frame containing the IDP Admin2 data matching the specified criteria.
# Fetch IDP data at Admin Level 2
idp_admin2_df <- get_idp_admin2_data(Operation='Yemen conflict', CountryName="Yemen")
head(idp_admin2_df)