getData: Access specific datasets

View source: R/getData.R

getDataR Documentation

Access specific datasets

Description

Access various datasets used in vignettes and studies associated with the broader lbmech project

Usage

getData(data, name = NULL, dir = tempdir(), timeout = 999)

Arguments

data

A character string indicating the name of the dataset to access. See details below.

name

For values of data that download data (see details), what will be the file/directory name of the downloaded items?

dir

Directory to which downloaded data will be saved. Default is tempdior().

timeout

How many seconds before downloads time out? Default is 999. Temporarily overrides value in getOptions("timeout").

Details

data = 'baleares-currents' imports ocean current data around Mallorca, Menorca, and Cabrera on June 13, 2022. Data originally downloaded from E.U. Copernicus Marine Service Information. See Clementi et al. (2021). An internet connection is not needed, and parameters name and dir are ignored.

data = 'baleares-gps' downloads GPS tracks for human hikes in the Balearic Islands in GPX format from https://osf.io/77n9t/. See Lera et al. (2017). The name parameter will define the folder name in the dir directory to which the .gpx files are saved. Default name = 'gpx'. getData will not import these tracks, for that, use importGPX. An internet connection is required

data = 'baleares-places' imports a SpatVector with twelve locations on Mallorca, Menorca, and Cabrera in the Balearic Islands. See Clementi et al. (2021).

data = 'gdp' downloads country GDP estimates since 1970 from the World Bank and United Nations. An internet connection is required.

data = 'population' downloads country population estimates since 1950 from the United Nations. An internet connection is required.

data = 'trade' downloads nation-wise bilateral trade data in goods and services. Trade in goods from the OECD, and trade in services from the WTO and OECD. An internet connection is required.

Value

Various, depending on data selection:

data = 'baleares-currents' returns a SpatRaster with ocean current surface velocities in m/s.

data = 'baleares-gpx' does not return any object, but creates a sub-directory name in directory dir with 15,373 GPX files, of which 15,371 can be successfully imported using importGPX.

data = 'baleares-places' imports a SpatVector with twelve points.

data = 'gdp' imports a data.table with seven columns for Year, Country Code, Country Name, the UN's GDP estimate, the World Bank's GDP estimate, the average GDP estimate, and the UN's GNI estimate.

data = 'population' imports a data.table with three columns for the Country Code, Year, and Population estimate.

data = 'trade' imports a data.table with seven columns. The country codes and names for the nation from which and to which trade is conducted, and the total value of the services and goods exchanged.

References

Clementi, E., Aydogdu A., Goglio, A. C., Pistoia J., Escudier R., Drudi M., Grandi A., et al. (2021). Mediterranean Sea Physics Analysis and Forecast (CMEMS MED-Currents, EAS6 System). Copernicus Marine Service. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.25423/CMCC/MEDSEA_ANALYSISFORECAST_PHY_006_013_EAS7")}.

Lera I., Perez T., Guerrero C., Eguiluz V. M., Juiz C. (2017). Analysing human mobility patterns of hiking activities through complex network theory. PLoS ONE 12(5): e0177712. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1371/journal.pone.0177712")}

Organization for Economic Co-Operation and Development (2022). Bilateral Trade Database by Industry and End-Use (BTDIxE). https://www.oecd.org/sti/ind/bilateraltradeingoodsbyindustryandend-usecategory.htm

United Nations (2022). UNData. https://data.un.org/

World Bank (2022). World Bank DataBank. https://databank.worldbank.org/

World Trade Organization, Organization for Economic Co-Operation and Development. (2023). WTO-OECD Balanced Trade in Services Dataset (BaTiS) - BPM6. https://www.wto.org/english/res_e/statis_e/trade_datasets_e.htm#BaTis6

Examples

# Import ocean current data for the Balearic Islands

currents <- getData('baleares-currents')

andresgmejiar/lbmech documentation built on Feb. 2, 2025, 12:37 a.m.