Skip to contents

Retrieve IDP data at Admin 0 level based on specified parameters. At least one of the following parameters must be provided: Operation, CountryName, or Admin0Pcode.

Usage

get_idp_admin0_data(
  Operation = NULL,
  CountryName = NULL,
  Admin0Pcode = NULL,
  FromReportingDate = NULL,
  ToReportingDate = NULL,
  FromRoundNumber = 0,
  ToRoundNumber = 0
)

Arguments

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).

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.

Value

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

Examples

# Fetch IDP data at Admin Level 0
idp_admin0_df <- get_idp_admin0_data(CountryName='Ethiopia', FromRoundNumber=1, ToRoundNumber=10)
head(idp_admin0_df)
#>     id                operation admin0Name admin0Pcode numPresentIdpInd
#> 1 9217   Countrywide monitoring   Ethiopia         ETH          1696145
#> 2 9218   Countrywide monitoring   Ethiopia         ETH          1742461
#> 3 9219   Countrywide monitoring   Ethiopia         ETH          1613436
#> 4 8427 Northern Ethiopia Crisis   Ethiopia         ETH           131590
#> 5 8428 Northern Ethiopia Crisis   Ethiopia         ETH           378392
#> 6 8429 Northern Ethiopia Crisis   Ethiopia         ETH          1025676
#>         reportingDate yearReportingDate monthReportingDate roundNumber
#> 1 2017-12-31T00:00:00              2017                 12           8
#> 2 2018-02-28T00:00:00              2018                  2           9
#> 3 2018-04-30T00:00:00              2018                  4          10
#> 4 2021-01-31T00:00:00              2021                  1           2
#> 5 2021-02-28T00:00:00              2021                  2           3
#> 6 2021-03-31T00:00:00              2021                  3           4
#>   assessmentType
#> 1             SA
#> 2             SA
#> 3             SA
#> 4             SA
#> 5             SA
#> 6             SA