Package 'dtmapi'

Title: Fetching Data from the 'Displacement Tracking Matrix'
Description: Allows humanitarian community, academia, media, government, and non-governmental organizations to utilize the data collected by the 'Displacement Tracking Matrix' (<https://dtm.iom.int>), a unit in the International Organization for Migration. This also provides non-sensitive Internally Displaced Person figures, aggregated at the country, Admin 1 (states, provinces, or equivalent), and Admin 2 (smaller administrative areas) levels.
Authors: Luong Bang Tran [aut, cre]
Maintainer: Luong Bang Tran <[email protected]>
License: MIT + file LICENSE
Version: 0.0.3
Built: 2025-03-07 16:53:19 UTC
Source: https://github.com/displacement-tracking-matrix/dtmapi-r

Help Index

Fetch All Countries

Description

Retrieve all countries for which DTM data is publicly available through the API.

Usage

get_all_countries()

Value

A data frame containing the list of all countries.

Examples

# Fetch all countries
countries_df <- get_all_countries()
head(countries_df)

Fetch All Operations

Description

Retrieve all operations for which DTM data is publicly available through the API.

Usage

get_all_operations()

Value

A data frame containing the list of all operations.

Examples

# Fetch all operations
operations_df <- get_all_operations()
head(operations_df)

Fetch IDP Admin0 Data

Description

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)

Fetch IDP Admin1 Data

Description

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

Usage

get_idp_admin1_data(
  Operation = NULL,
  CountryName = NULL,
  Admin0Pcode = NULL,
  Admin1Name = NULL,
  Admin1Pcode = 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).
Admin1Name

Optional; Name of level 1 administrative boundaries.
Admin1Pcode

Optional; Place code of level 1 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.

Value

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

Examples

# Fetch IDP data at Admin Level 1
idp_admin1_df <- get_idp_admin1_data(CountryName='Sudan')
head(idp_admin1_df)

Fetch IDP Admin2 Data

Description

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.

Usage

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
)

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

Value

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

Examples

# Fetch IDP data at Admin Level 2
idp_admin2_df <- get_idp_admin2_data(Operation='Yemen conflict', CountryName="Yemen")
head(idp_admin2_df)