https://github.com/agrdatasci/ag5tools

R toolbox to download and extract data from the "Agrometeorological indicators from 1979 to present derived from reanalysis" (AgERA5) dataset.

https://github.com/agrdatasci/ag5tools

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary

Keywords

agriculture-research agrometeorological climate-data r r-package
Last synced: 5 months ago · JSON representation

Repository

R toolbox to download and extract data from the "Agrometeorological indicators from 1979 to present derived from reanalysis" (AgERA5) dataset.

Basic Info
Statistics
  • Stars: 8
  • Watchers: 8
  • Forks: 6
  • Open Issues: 3
  • Releases: 2
Topics
agriculture-research agrometeorological climate-data r r-package
Created almost 6 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License Code of conduct

README.md

R-CMD-check CRAN Downloads Contributor Covenant <!-- badges: end -->

ag5Tools

Toolbox for downloading and extracting data from the Copernicus AgERA5 dataset

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 r install.packages("ag5Tools")
The development version could be installed using r 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

Examples

Downloading data

The following example downloads daily '2m_temperature' data for year 2015

r 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"

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

Owner

  • Name: AgrDataSci
  • Login: AgrDataSci
  • Kind: organization
  • Email: k.desousa@cgiar.org
  • Location: France

We develop methods and tools to support sustainable food systems, rural development and digital inclusion

GitHub Events

Total
  • Issues event: 2
  • Issue comment event: 2
  • Push event: 6
  • Pull request event: 1
  • Create event: 1
Last Year
  • Issues event: 2
  • Issue comment event: 2
  • Push event: 6
  • Pull request event: 1
  • Create event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 151
  • Total Committers: 2
  • Avg Commits per committer: 75.5
  • Development Distribution Score (DDS): 0.02
Past Year
  • Commits: 20
  • Committers: 2
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.05
Top Committers
Name Email Commits
David Brown 5****f 148
kauedesousa k****a@i****o 3
Committer Domains (Top 20 + Academic)
inn.no: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 8
  • Total pull requests: 3
  • Average time to close issues: 15 days
  • Average time to close pull requests: about 22 hours
  • Total issue authors: 6
  • Total pull request authors: 1
  • Average comments per issue: 2.63
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 2
  • Average time to close issues: 1 day
  • Average time to close pull requests: 2 minutes
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 2.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • howardvanmeer (2)
  • adamhsparks (2)
  • dbrownf (1)
  • nicolaycunha (1)
  • dcol2804 (1)
  • m-hrachov (1)
Pull Request Authors
  • dbrownf (5)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 300 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: ag5Tools

Toolbox for Downloading and Extracting Copernicus AgERA5 Data

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 300 Last month
Rankings
Forks count: 12.2%
Stargazers count: 20.6%
Dependent repos count: 23.8%
Average: 25.0%
Dependent packages count: 28.7%
Downloads: 39.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • doSNOW * imports
  • foreach * imports
  • fs * imports
  • reticulate * imports
  • terra * imports
  • knitr * suggests
  • rmarkdown * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite