Description
The R package ag5Tools is a toolbox to download and extract data from the “Agrometeorological indicators from 1979 to present derived from reanalysis” dataset (AgERA5).
A description of the dataset can found here
The download function provides programmatic access to the Copernicus Climate Data Store to download AgERA5 data.
A detailed description of the ag5Tools package can be found in the companion paper: https://doi.org/10.1016/j.softx.2022.101267
Data license
The ag5Tools package does not distribute data, it only provides access to the Climate Data Store through the Python cdsapi.
For specific details about the license agreement on downloading and using Copernicus Products, please check the license here
Installation
The stable version of ag5Tools can be installed from CRAN using
install.packages("ag5Tools")The development version could be installed using
devtools::install_github("agrdatasci/ag5Tools", build_vignettes = TRUE)Downloading AgERA5 data
Install Python and the CDS API
Before using the ag5Tools package, you need to intall Python and the CDS API, please see the detailsin the CDSAPI guide
Get your CDS API-Key
To download AgERA5 data you should first register at the Climate Data Store and get your API key. Please follow the instructions detailed in the CDSAPI guide
You need to create a file to store the API key. Please follow the instructions detailed here
Downloading data
The following example downloads daily ‘2m_temperature’ data for year 2015
ag5_download(variable = "2m_temperature",
statistic = "night_time_minimum",
day = "all",
month = "all",
year = 2015,
path = "C:/custom_target_folder"
)Extracting data
To extract maximum day temperature (“Max-Day-Time”) of “2m_temperature”
ag5_extract(coords = c(35.726364, -2.197162),
dates = "1995-01-23",
variable = "2m_temperature",
statistic = "Max-Day-Time",
path = "C:/agera5_data")Acknowledgements
The ag5Tools package relies on the functionality available from other open source packages.
The Python cdsapi
The R package reticulate is used to access the Python CDS API functions from R.
The R package terra is used to extract data from nc files.
The R package fs is used for efficiently search and list files.
License
Please be aware that ag5Tools is released under MIT license, please find details in the MIT license document
Citation
To cite the ag5Tools in scientific publications please use:
Brown, D., de Sousa, K., & van Etten, J. (2023). ag5Tools: An R package for downloading and extracting agrometeorological data from the AgERA5 database. SoftwareX, 21, 101267. https://doi.org/10.1016/j.softx.2022.101267
Code of Conduct
Please note that the ag5Tools project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.