Data

Tools

Indexes

Applications

Experiments

Open Source Science

droughtr

An R package for non-stationary meteorological drought monitoring

https://github.com/mammask/droughtr

Science Score: 23.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
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary

Keywords

bias bias-correction forecasting hydrology time-series
Last synced: 6 months ago · JSON representation

Repository

An R package for non-stationary meteorological drought monitoring

Basic Info
  • Host: GitHub
  • Owner: mammask
  • License: other
  • Language: R
  • Default Branch: main
  • Homepage:
  • Size: 7.03 MB
Statistics
  • Stars: 9
  • Watchers: 1
  • Forks: 4
  • Open Issues: 0
  • Releases: 3
Topics
bias bias-correction forecasting hydrology time-series
Created over 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.Rmd 

---
title: "droughtR"
link-citations: true
bibliography: references.bib
output: github_document
---

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


[![DOI](https://zenodo.org/badge/398032827.svg)](https://zenodo.org/doi/10.5281/zenodo.10009276)

[![codecov](https://codecov.io/gh/mammask/droughtR/graph/badge.svg?token=WYHK9P2NXP)](https://codecov.io/gh/mammask/droughtR)



The goal of `droughtR` is to enable meteorological drought monitoring by generating non-stationary drought indices under various distributional assumptions (Normal, Gamma, Zero Inflated Gamma and Weibull). It computes the stationary (SPI) and the non-stationary (NSPI) Standardized Precipitation Indices using General Additive Models for Location Scale and Shape (GAMLSS). 



```{r, echo = FALSE}
knitr::opts_chunk$set(
  fig.path = "README_figs/README-"
)
```

## Installation

```{r, eval=FALSE}
# Install the development version on Github
devtools::install_github("mammask/droughtR")
```

## Usage

### Generate SPI and NSPI

The function `computenspi` creates stationary and non-stationary meteorological drought indices at different time scales. By default, droughtR uses the gamma distribution:

```{r, eval=TRUE, fig.height=3, fig.width=9, fig.align='center'}
# Load droughtR library
library(droughtR)

# Generate synthetic monthly rainfall data using the Gamma distribution
rain = dummyrainfall(startYear = 1950, endYear = 2010)

# Compute the non-stationary standardized precipitation index (NSPI) for scale 12 using GAMLSS
nonstatdrought = computenspi(x = rain, stationaryspi = FALSE, spiScale = 12, dist = 'gamma')

# Plot NSPI
plot(nonstatdrought)
```

```{r, fig.height=3, fig.width=9, fig.align='center'}
# Compute the stationary standardized precipitation index (NSPI) for scale 12 using GAMLSS and the weibull distribution
statdrought = computenspi(x = rain, stationaryspi = TRUE, spiScale = 12, dist = 'weibull')

# Plot SPI 
plot(statdrought)
```

Owner

  • Name: Kostas Mammas
  • Login: mammask
  • Kind: user
  • Location: Rhodes, Greece
  • Company: IQVIA

Director Regional Analytics, EMEA | Statistical Programmer | Time Series Forecasting

GitHub Events

Total
Last Year

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 49
  • Total Committers: 2
  • Avg Commits per committer: 24.5
  • Development Distribution Score (DDS): 0.449
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Mammas k****s@i****m 27
Kostas Mammas m****k@l****m 22
Committer Domains (Top 20 + Academic)
iqvia.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total 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
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
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

DESCRIPTION cran
  • SPEI * imports
  • data.table * imports
  • forecast * imports
  • gamlss * imports
  • gamlss.dist * imports
  • ggplot2 * imports
  • stats * imports
  • zoo * imports
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite