Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Browse accepted projects | Review proposed projects | Propose new project | Open Issues

chirps

A quasi-global high-resolution 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.
https://github.com/ropensci/chirps

chirps climatology precipitation-data rstats

Last synced: about 3 hours ago
JSON representation

Repository metadata

API Client for CHIRPS

README

        

[![peer-review](https://badges.ropensci.org/357_status.svg)](https://github.com/ropensci/software-review/issues/357)
[![status](https://joss.theoj.org/papers/3367fdbff2db55a60c1ab7d611017940/status.svg)](https://joss.theoj.org/papers/3367fdbff2db55a60c1ab7d611017940)
[![CRAN status](https://www.r-pkg.org/badges/version/chirps)](https://cran.r-project.org/package=chirps)
[![codecov](https://codecov.io/gh/ropensci/chirps/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/chirps)
[![Project Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![DOI](https://zenodo.org/badge/225693680.svg)](https://zenodo.org/badge/latestdoi/225693680)
[![tic](https://github.com/ropensci/chirps/workflows/tic/badge.svg?branch=master)](https://github.com/ropensci/chirps/actions)

# *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 .

## 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")

install_github("ropensci/chirps", build_vignettes = 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](https://docs.ropensci.org/chirps/) 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.

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

## Meta

- Please [report any issues or bugs](https://github.com/ropensci/chirps/issues).

- 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](CONTRIBUTING.md).

- Please note that the *chirps* project is released with a a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 24 days ago

Total Commits: 224
Total Committers: 3
Avg Commits per committer: 74.667
Development Distribution Score (DDS): 0.496

Commits in past year: 2
Committers in past year: 1
Avg Commits per committer in past year: 2.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
kauedesousa k****a@i****o 113
Adam H. Sparks a****s@g****m 110
Patrick Hausmann p****n@c****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 44
Total pull requests: 4
Average time to close issues: 2 months
Average time to close pull requests: 23 minutes
Total issue authors: 18
Total pull request authors: 4
Average comments per issue: 3.75
Average comments per pull request: 0.5
Merged pull request: 4
Bot issues: 0
Bot pull requests: 0

Past year issues: 2
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 2
Past year pull request authors: 0
Past year average comments per issue: 0.0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ropensci/chirps

Top Issue Authors

  • adamhsparks (18)
  • kauedesousa (10)
  • zackarno (1)
  • xuxoramos (1)
  • samyadelara (1)
  • Rohit-Satyam (1)
  • Robinlovelace (1)
  • pahanc (1)
  • Nblws (1)
  • ms1948 (1)
  • MariusHees (1)
  • maelle (1)
  • mabesa (1)
  • jdnmiguel (1)
  • eggenm (1)

Top Pull Request Authors

  • maelle (1)
  • patperu (1)
  • kauedesousa (1)
  • adamhsparks (1)

Top Issue Labels

  • enhancement (11)
  • bug (7)
  • documentation (4)
  • help wanted (1)
  • wontfix (1)

Top Pull Request Labels


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

Score: 4.709530201312334