chirps

chirps: API Client for the CHIRPS Precipitation Data in R - Published in JOSS (2020)

https://github.com/ropensci/chirps

Science Score: 93.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 5 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

chirps climatology precipitation-data rstats
Last synced: 6 months ago · JSON representation

Repository

API Client for CHIRPS

Basic Info
Statistics
  • Stars: 31
  • Watchers: 6
  • Forks: 13
  • Open Issues: 13
  • Releases: 3
Topics
chirps climatology precipitation-data rstats
Created about 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codemeta

README.md

peer-review status CRAN status Project Status DOI R-CMD-check Codecov test coverage <!-- badges: end -->

chirps: API Client for CHIRPS and CHIRTS

Overview

chirps provides the API Client for the Climate Hazards Center 'CHIRPS' and 'CHIRTS'. The 'CHIRPS' data is a quasi-global (50°S – 50°N) high-resolution (0.05 arc-degrees) rainfall data set, which incorporates satellite imagery and in-situ station data to create gridded rainfall time series for trend analysis and seasonal drought monitoring. 'CHIRTS' is a quasi-global (60°S – 70°N), high-resolution data set of daily maximum and minimum temperatures. For more details on 'CHIRPS' and 'CHIRTS' data please visit its official home page https://www.chc.ucsb.edu/data.

Quick start

From CRAN

The stable version is available through CRAN.

r install.packages("chirps")

From GitHub

A development version that may have new features or bug fixes is available through GitHub.

``` r library("remotes")

installgithub("ropensci/chirps", buildvignettes = TRUE) ```

Example

Fetch CHIRPS data from three points across the Tapajós National Forest (Brazil) from in Jan-2017. The default procedure will download the COG files from the CHIRPS server and handle it internally using the package terra. This is more interesting when dealing with hundreds of points and days. Data can be returned as a matrix using the argument as.matrix = TRUE.

```r library("chirps")

lonlat <- data.frame(lon = c(-55.0281,-54.9857, -55.0714), lat = c(-2.8094, -2.8756, -3.5279))

dates <- c("2017-01-01", "2017-01-31")

dat <- get_chirps(lonlat, dates, server = "CHC", as.matrix = FALSE)

```

For a faster download of few datapoints (~ 10 datapoints), the argument server = "ClimateSERV" can be used

```r library("chirps")

lonlat <- data.frame(lon = c(-55.0281,-54.9857, -55.0714), lat = c(-2.8094, -2.8756, -3.5279))

dates <- c("2017-01-01", "2017-01-31")

dat <- get_chirps(lonlat, dates, server = "ClimateSERV", as.matrix = FALSE)

```

Going further

The full functionality of chirps is illustrated in the package vignette. The vignette can be found on the package website or from within R once the package has been installed, e.g. via:

r vignette("Overview", package = "chirps")

Use of CHIRPS data

While chirps does not redistribute the data or provide it in any way, we encourage users to cite Funk et al. (2015) when using CHIRPS and Funk et al. (2019) when using CHIRTS

Funk C., Peterson P., Landsfeld M., … Michaelsen J. (2015). The climate hazards infrared precipitation with stations—a new environmental record for monitoring extremes. Scientific Data, 2, 150066. https://doi.org/10.1038/sdata.2015.66

Funk, C., Peterson, P., Peterson, S., … Mata, N. (2019). A high-resolution 1983–2016 TMAX climate data record based on infrared temperatures and stations by the climate hazard center. Journal of Climate, 32(17), 5639–5658. https://doi.org/10.1175/JCLI-D-18-0698.1

Meta

  • Please report any issues or bugs.

  • License: MIT.

  • Get citation information for chirps in R by typing citation(package = "chirps").

  • You are welcome to contribute to the chirps project. Please read our contribution guidelines.

  • Please note that the chirps project is released with a a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Owner

  • Name: rOpenSci
  • Login: ropensci
  • Kind: organization
  • Email: info@ropensci.org
  • Location: Berkeley, CA

JOSS Publication

chirps: API Client for the CHIRPS Precipitation Data in R
Published
July 01, 2020
Volume 5, Issue 51, Page 2419
Authors
Kauê de Sousa ORCID
Department of Agricultural Sciences, Inland Norway University of Applied Sciences, Hamar, Norway, Bioversity International, Rome, Italy
Adam H. Sparks ORCID
Centre for Crop Health, University of Southern Queensland, Toowoomba, Australia
William Ashmall
Universities Space Research Association, National Aeronautics and Space Administration (NASA), Huntsville, USA
Jacob van Etten ORCID
Bioversity International, Rome, Italy
Svein Ø. Solberg ORCID
Department of Agricultural Sciences, Inland Norway University of Applied Sciences, Hamar, Norway
Editor
Daniel S. Katz ORCID
Tags
CHIRPS climate data climatology earth science evapotranspiration precipitation data reproducibility weather data

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "chirps",
  "description": "API Client for the Climate Hazards Center 'CHIRPS' and 'CHIRTS'. The 'CHIRPS' data is a quasi-global (50°S – 50°N) high-resolution (0.05 arc-degrees) rainfall data set, which incorporates satellite imagery and in-situ station data to create gridded rainfall time series for trend analysis and seasonal drought monitoring. 'CHIRTS' is a quasi-global (60°S – 70°N), high-resolution data set of daily maximum and minimum temperatures. For more details on 'CHIRPS' and 'CHIRTS' data please visit its official home page <https://www.chc.ucsb.edu/data>.",
  "name": "chirps: API Client for CHIRPS and CHIRTS",
  "codeRepository": "https://github.com/ropensci/chirps",
  "issueTracker": "https://github.com/ropensci/chirps/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.1.5",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.1 (2024-06-14)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Kauê",
      "familyName": "de Sousa",
      "email": "desousa.kaue@gmail.com",
      "@id": "https://orcid.org/0000-0002-7571-7845"
    },
    {
      "@type": "Person",
      "givenName": "Adam H.",
      "familyName": "Sparks",
      "@id": "https://orcid.org/0000-0002-0061-8359"
    },
    {
      "@type": "Person",
      "givenName": "Aniruddha",
      "familyName": "Ghosh",
      "@id": "https://orcid.org/0000-0003-3667-8019"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Pete",
      "familyName": "Peterson"
    },
    {
      "@type": "Person",
      "givenName": "William",
      "familyName": "Ashmall"
    },
    {
      "@type": "Person",
      "givenName": "Jacob",
      "familyName": "van Etten",
      "@id": "https://orcid.org/0000-0001-7554-2558"
    },
    {
      "@type": "Person",
      "givenName": "Svein Ø.",
      "familyName": "Solberg",
      "@id": "https://orcid.org/0000-0002-4491-4483"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Kauê",
      "familyName": "de Sousa",
      "email": "desousa.kaue@gmail.com",
      "@id": "https://orcid.org/0000-0002-7571-7845"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "climatrends",
      "name": "climatrends",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=climatrends"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "markdown",
      "name": "markdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=markdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.5.0"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "httr",
      "name": "httr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "stats",
      "name": "stats"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "terra",
      "name": "terra",
      "version": ">= 1.2-10",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=terra"
    },
    "SystemRequirements": null
  },
  "fileSize": "1559.449KB",
  "citation": [
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2020",
      "author": [
        {
          "@type": "Person",
          "givenName": "Kauê",
          "familyName": "de Sousa"
        },
        {
          "@type": "Person",
          "givenName": "Adam H.",
          "familyName": "Sparks"
        },
        {
          "@type": "Person",
          "givenName": "William",
          "familyName": "Ashmall"
        },
        {
          "@type": "Person",
          "givenName": "Jacob",
          "familyName": "van Etten"
        },
        {
          "@type": "Person",
          "givenName": "Svein Ø.",
          "familyName": "Solberg"
        }
      ],
      "name": "{chirps: API Client for the CHIRPS Precipitation Data in R}",
      "identifier": "10.21105/joss.02419",
      "url": "https://doi.org/10.21105/joss.02419",
      "pagination": "2419",
      "@id": "https://doi.org/10.21105/joss.02419",
      "sameAs": "https://doi.org/10.21105/joss.02419",
      "isPartOf": {
        "@type": "PublicationIssue",
        "issueNumber": "51",
        "datePublished": "2020",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "5",
          "name": "The Journal of Open Source Software"
        }
      }
    }
  ],
  "relatedLink": [
    "https://docs.ropensci.org/chirps/",
    "https://CRAN.R-project.org/package=chirps"
  ],
  "releaseNotes": "https://github.com/ropensci/chirps/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/chirps/blob/master/README.md",
  "contIntegration": [
    "https://codecov.io/gh/ropensci/chirps",
    "https://github.com/ropensci/chirps/actions/workflows/R-CMD-check.yaml",
    "https://app.codecov.io/gh/ropensci/chirps"
  ],
  "developmentStatus": "https://www.repostatus.org/#active",
  "review": {
    "@type": "Review",
    "url": "https://github.com/ropensci/software-review/issues/357",
    "provider": "https://ropensci.org"
  },
  "keywords": [
    "climatology",
    "precipitation-data",
    "rstats",
    "chirps"
  ]
}

GitHub Events

Total
  • Issues event: 3
  • Watch event: 2
  • Issue comment event: 3
  • Push event: 10
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Issues event: 3
  • Watch event: 2
  • Issue comment event: 3
  • Push event: 10
  • Pull request event: 2
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 320
  • Total Committers: 4
  • Avg Commits per committer: 80.0
  • Development Distribution Score (DDS): 0.366
Past Year
  • Commits: 22
  • Committers: 2
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.091
Top Committers
Name Email Commits
Adam H. Sparks a****s@g****m 203
kauedesousa k****a@i****o 115
Patrick Hausmann p****n@c****e 1
Maëlle Salmon m****n@y****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 48
  • Total pull requests: 5
  • Average time to close issues: 3 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 20
  • Total pull request authors: 4
  • Average comments per issue: 3.58
  • Average comments per pull request: 0.4
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: 3 months
  • Average time to close pull requests: 10 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • adamhsparks (19)
  • kauedesousa (11)
  • hydroversebr (1)
  • mabesa (1)
  • albirayi (1)
  • Robinlovelace (1)
  • ms1948 (1)
  • xuxoramos (1)
  • MariusHees (1)
  • peetmate (1)
  • ani-ghosh (1)
  • jdnmiguel (1)
  • samyadelara (1)
  • Nblws (1)
  • zackarno (1)
Pull Request Authors
  • adamhsparks (3)
  • maelle (1)
  • kauedesousa (1)
  • patperu (1)
Top Labels
Issue Labels
enhancement (11) bug (7) documentation (4) help wanted (1) wontfix (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
proxy.golang.org: github.com/ropensci/chirps
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • methods * depends
  • httr * imports
  • jsonlite * imports
  • sf * imports
  • stats * imports
  • terra >= 1.2 imports
  • climatrends * suggests
  • knitr * suggests
  • markdown * suggests
  • rmarkdown * suggests
  • testthat >= 2.1.0 suggests
  • vcr >= 0.5 suggests
.github/workflows/tic.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v2 composite
  • pat-s/always-upload-cache v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-tinytex v2 composite
.github/workflows/update-tic.yml actions
  • actions/checkout v2 composite
  • peter-evans/create-pull-request v3 composite
  • r-lib/actions/setup-r master composite