Data

Tools

Indexes

Applications

Experiments

Open Source Science

loadflux

An R package for river suspended sediment dynamics study.

https://github.com/atsyplenkov/loadflux

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

Keywords

r r-package rstats
Last synced: 10 months ago · JSON representation

Repository

An R package for river suspended sediment dynamics study.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Topics
r r-package rstats
Created over 5 years ago · Last pushed over 3 years ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
---



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

# loadflux 



[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/loadflux)](https://cran.r-project.org/package=loadflux)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6992087.svg)](https://doi.org/10.5281/zenodo.6992087)
[![](http://cranlogs.r-pkg.org/badges/grand-total/loadflux)](https://cran.r-project.org/package=loadflux)
[![codecov](https://codecov.io/gh/atsyplenkov/loadflux/branch/master/graph/badge.svg?token=DI1DCJV15D)](https://app.codecov.io/gh/atsyplenkov/loadflux/)
[![R-CMD-check](https://github.com/atsyplenkov/loadflux/workflows/R-CMD-check/badge.svg)](https://github.com/atsyplenkov/loadflux/actions/)
[![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/)


The `loadflux` package is build for the comprehensive analysis of the intra-event suspended sediment dynamics.

## Installation



You can install the development version from [GitHub](https://github.com/atsyplenkov/loadflux/) with:

``` r
# install.packages("devtools")
devtools::install_github("atsyplenkov/loadflux")
```
## Example

This is a basic example which shows you how to split your series into hydrological events:

```{r example, message=FALSE, warning=FALSE}
library(dplyr)
library(loadflux)
data(djan)

df <- djan %>% 
  hydro_events(q = discharge,
               datetime = time,
               window = 21)

head(df)
```

### Plots

Then you can  plot the hysteresis loop by running `hysteresis_plot`

```{r hysteresis_plot, message=FALSE, warning=FALSE, out.width = "50%", fig.align='center'}
library(ggplot2)

df %>% 
  filter(he == 2) %>%
  hysteresis_plot(q = discharge,
                  ssc = SS,
                  base_font_size = 14)
```

### Hyseteresis indexes

This package also contains several function for hysteresis index calculation:

**Added**

- `SHI` - Simple Hystersis Index from [*Tsyplenkov et al., 2020*](https://link.springer.com/article/10.1007/s11368-020-02633-z/)
- `AHI` - Aich's Hysteresis Index from [*Aich et al., 2014*](https://www.sciencedirect.com/science/article/abs/pii/S0341816214001969/)

**Pending**

- `HImid` - Hysteresis Index from [*Lawler et al., 2006*](https://www.sciencedirect.com/science/article/abs/pii/S0048969705005711/)

To calculate a hysteresis index for your event run as follows:

```{r shi, message=FALSE, warning=FALSE}

df %>% 
  filter(he == 2) %>% 
  SHI(q = discharge,
      ssc = SS)

```


### ACKNOWLEDGEMENTS
_This package was developed in accordance to the Development program of the Interdisciplinary Scientific and Educational School of M.V. Lomonosov Moscow State University "Future Planet and Global Environmental Change"_

Owner

  • Name: Anatolii Tsyplenkov
  • Login: atsyplenkov
  • Kind: user
  • Location: New Zealand
  • Company: @manaakiwhenua

Scientist-Geomorphologist and Research Software Engineer, fond of all things geospatial

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 51
  • Total Committers: 2
  • Avg Commits per committer: 25.5
  • Development Distribution Score (DDS): 0.49
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Anatolii Tsyplenkov 3****v 26
atsyplenkov a****v@g****m 25

Issues and Pull Requests

Last synced: about 1 year 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

Packages

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

Explore Intra-Event Suspended Sediment Dynamics

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 181 Last month
Rankings
Forks count: 21.9%
Stargazers count: 22.5%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Average: 37.1%
Downloads: 75.8%
Maintainers (1)
atsyplenkov@gmail.com
Last synced: about 1 year ago

Dependencies

DESCRIPTION cran
  • R >= 3.5 depends
  • dplyr >= 1.0.0 imports
  • dygraphs * imports
  • ggplot2 >= 3.0.0 imports
  • lubridate * imports
  • rlang >= 0.2.0 imports
  • tidyr * imports
  • tsibble >= 0.9.0 imports
  • xts * imports
  • zoo * imports
  • brolgar * suggests
  • covr * suggests
  • fabletools * suggests
  • feasts * suggests
  • knitr * suggests
  • lifecycle * suggests
  • purrr * suggests
  • rmarkdown * suggests
  • stats * suggests
  • testthat >= 3.0.0 suggests
  • utils * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/check-r-package v1 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/pkgdown.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite