Data

Tools

Indexes

Applications

Experiments

Open Source Science

eddi

R package for the Evaporative Demand Drought Index (EDDI) data product

https://github.com/earthlab/eddi

Science Score: 10.0%

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

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.9%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

R package for the Evaporative Demand Drought Index (EDDI) data product

Basic Info
Statistics
  • Stars: 4
  • Watchers: 8
  • Forks: 6
  • Open Issues: 2
  • Releases: 0
Created over 7 years ago · Last pushed almost 5 years ago
Metadata Files
Readme Code of conduct

README.Rmd 

---
output: github_document
---



```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# eddi: R package for the NOAA Evaporative Demand Drought Index

[![R-CMD-check](https://github.com/earthlab/eddi/workflows/R-CMD-check/badge.svg)](https://github.com/earthlab/eddi/actions)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/earthlab/eddi?branch=master&svg=true)](https://ci.appveyor.com/project/earthlab/eddi)
[![Codecov](https://img.shields.io/codecov/c/github/earthlab/eddi.svg)](https://codecov.io/gh/earthlab/eddi)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/eddi)](https://cran.r-project.org/package=eddi)
[![rstudio mirror downloads](http://cranlogs.r-pkg.org/badges/eddi)](https://github.com/metacran/cranlogs.app)
[![DOI](https://zenodo.org/badge/160215566.svg)](https://zenodo.org/badge/latestdoi/160215566)


The eddi R package facilitates access to the NOAA [Evaporative Demand Drought 
Index](https://www.esrl.noaa.gov/psd/eddi/) (EDDI) data product. 

## Installation

Install the most recently released version of the eddi package from CRAN: 

```r
install.packages('eddi')
```

Or, you can install the development version of eddi with devtools:

``` r
# install.packages("devtools")
devtools::install_github("earthlab/eddi")
```

## Example

The EDDI product exists for multiple timescales,  including the 1 to 12 week 
and 1 to 12 months scales. 
Shorter time scales can detect short term droughts, e.g., "flash droughts", 
and longer time scales are appropriate for detecting long term drought.
For more information see https://www.esrl.noaa.gov/psd/eddi/.

This is a basic example which shows you how to get EDDI data for Nov 29, 2018 at
the one month timescale:

```{r example}
library(eddi)

eddi_data <- get_eddi(date = "2018-11-29", timescale = "1 month")
eddi_data
```

This will always return a `RasterStack` object with each layer in the stack 
corresponding to a date, that can be visualized using `raster::plot`. 
Here, large positive values indicate exceptionally dry conditions, and 
large negative values indicate exceptionally wet conditions, with values of 0
indicating median EDDI values.

```{r plot-example}
color_pal <- colorRampPalette(c("blue", "lightblue", "white", "pink", "red"))
raster::plot(eddi_data, col = color_pal(255), main = "EDDI data for 2018-11-29")
```

## EDDI Resources 

A user guide for EDDI can be found here: 
https://www.esrl.noaa.gov/psd/eddi/pdf/EDDI_UserGuide_v1.0.pdf

For the science behind EDDI, see these two papers: 

* M. Hobbins, A. Wood, D. McEvoy, J. Huntington, C. Morton, M. Anderson, and 
C. Hain (June 2016): The Evaporative Demand Drought Index: Part I – Linking 
Drought Evolution to Variations in Evaporative Demand. J. Hydrometeor., 
17(6), 1745-1761.  
* D. J. McEvoy, J. L. Huntington, M. T. Hobbins, A. Wood, C. Morton, 
M. Anderson, and C. Hain (June 2016): The Evaporative Demand Drought Index: 
Part II – CONUS-wide Assessment Against Common Drought Indicators. 
J. Hydrometeor., 17(6), 1763-1779.

Owner

  • Name: Earth Lab
  • Login: earthlab
  • Kind: organization
  • Location: Boulder, Colorado, USA

Capitalizing on the data deluge to accelerate science

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 77
  • Total Committers: 1
  • Avg Commits per committer: 77.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Max Joseph m****h@g****m 77

Issues and Pull Requests

Last synced: about 2 years ago

All Time
  • Total issues: 3
  • Total pull requests: 9
  • Average time to close issues: about 11 hours
  • Average time to close pull requests: 18 minutes
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.67
  • Average comments per pull request: 0.89
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mbjoseph (2)
  • ryanpeek (1)
Pull Request Authors
  • mbjoseph (8)
  • Ayesha28 (1)
  • ryanpeek (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
cran.r-project.org: eddi

Get Evaporative Demand Drought Index Raster Data

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 0
Rankings
Forks count: 10.1%
Stargazers count: 28.5%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Average: 38.7%
Downloads: 89.7%
Last synced: almost 2 years ago

Dependencies

DESCRIPTION cran
  • raster * imports
  • rgdal * imports
  • utils * imports
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • sf * suggests
  • sp * suggests
  • testthat * suggests