Data

Tools

Indexes

Applications

Experiments

Open Source Science

adc

Estimates of antecedent discharge conditions using R

https://github.com/txwri/adc

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
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

hydrology rstats water water-quality
Last synced: 11 months ago · JSON representation

Repository

Estimates of antecedent discharge conditions using R

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 2
Topics
hydrology rstats water water-quality
Created about 4 years ago · Last pushed about 3 years ago
Metadata Files
Readme License

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  dev = "ragg_png",
  dpi = 250,
  fig.dim = c(8,4),
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# adc


[![adc status badge](https://txwri.r-universe.dev/badges/adc)](https://txwri.r-universe.dev)


[![license](https://img.shields.io/badge/license-GPL (>= 3)-lightgrey.svg)](https://choosealicense.com/)
[![R-CMD-check](https://github.com/TxWRI/adc/workflows/R-CMD-check/badge.svg)](https://github.com/TxWRI/adc/actions)
[![Codecov test coverage](https://codecov.io/gh/TxWRI/adc/branch/main/graph/badge.svg)](https://app.codecov.io/gh/TxWRI/adc?branch=main)



adc provides functions to calculate discharge-based metrics that are useful 
in water quality concentration and flux regression equations.

## Installation

Install adc from CRAN:

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

The development version is available on https://txwri.r-universe.dev/adc and can be installed with:

``` r
install.packages('adc', repos = c(txwri = 'https://txwri.r-universe.dev'))
```

## Example

Flow anomalies represent how different the current discharge period is (current day, current week, current month, etc.) from previous periods (previous week, previous month, period of record, etc.). 

```{r example}
library(adc)
## example code is lavaca and includes dates and mean daily flow

data(lavaca)

x <- fa(lavaca$Flow,
        dates = lavaca$Date,
        T_1 = "1 month",
        T_2 = "1 year",
        clean_up = TRUE,
        transform = "log10")

plot(lavaca$Date, x, type = "l", xlab = "Date", ylab = "Anomaly [unitless]")
```

The packages also includes functions to calculate an exponentially weighted discounted flow, base-flow, and rate of change for mean daily streamflow. Functions generally work well using the `dplyr::mutate()` function to facilitate tidy workflows.

Owner

  • Name: Texas Water Resources Institute
  • Login: TxWRI
  • Kind: organization
  • Email: michael.schramm@ag.tamu.edu
  • Location: College Station, TX

A part of the Texas A&M System and Texas A&M Agrilife, the Texas Water Resources Institute solves vital water issues through research & outreach

GitHub Events

Total
Last Year

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 62
  • Total Committers: 2
  • Avg Commits per committer: 31.0
  • Development Distribution Score (DDS): 0.387
Past Year
  • Commits: 24
  • Committers: 1
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
mps9506 m****m@g****m 38
Michael Schramm m****m@a****u 24
Committer Domains (Top 20 + Academic)
agnet.tamu.edu: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 2
  • Total pull requests: 20
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 20
  • 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
  • mps9506 (2)
Pull Request Authors
  • mps9506 (20)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 291 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: adc

Calculate Antecedent Discharge Conditions

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 291 Last month
Rankings
Forks count: 28.8%
Dependent packages count: 29.8%
Stargazers count: 31.7%
Average: 32.9%
Dependent repos count: 35.5%
Downloads: 38.5%
Maintainers (1)
mpschramm@gmail.com
Last synced: 12 months ago

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • katex * imports
  • runner * imports
  • stats * imports
  • covr * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc 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 v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • r-lib/actions/setup-renv v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite