get_aggregated_disaster_data: Disaster aggregated data

Description Usage Arguments Value Author(s) Examples

View source: R/gets.R

Description

Returns all available disaster displacement data by country aggregating all the events

Usage

1
get_aggregated_disaster_data(iso3, year, limit, ci = idmc_api_key())

Arguments

iso3

Character. The country ISO3 code

year

Integer. The year of the records (default all years, it also accept ranges)

limit

Integer. Limit the number of records returned by the API

ci

A character vector of IDMC_API_KEY. See [idmc_api_key()].

Value

A data.frame

Author(s)

An Chu

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
## retrieve all data of Vietnam (VNM)
get_aggregated_disaster_data(iso = 'VNM')
## retrieve data from Vietnam in 2015
get_aggregated_disaster_data('VNM', year = 2015)
## retrieve data from Vietnam in period 2011-2015
get_aggregated_disaster_data('VNM', year = c(2011, 2015))
## limit the number of records returned by 10
get_aggregated_disaster_data('VNM', limit = 10)

## End(Not run)

chuvanan/idmcapi documentation built on Nov. 24, 2019, 7:31 a.m.