{"Type":"Package","Package":"loadflux","Title":"Explore Intra-Event Suspended Sediment Dynamics","Version":"0.0.2","Authors@R":"\nperson(\"Anatoly\", \"Tsyplenkov\", , \"atsyplenkov@gmail.com\", role = c(\"cre\", \"aut\"),\ncomment = c(ORCID = \"0000-0003-4144-8402\"))","Maintainer":"Anatoly Tsyplenkov ","Description":"A collection of functions created to study water discharge\n(Q) and suspended sediment concentration (SSC) relationship.","License":"MIT + file LICENSE","URL":"https://github.com/atsyplenkov/loadflux,\nhttps://atsyplenkov.github.io/loadflux/","BugReports":"https://github.com/atsyplenkov/loadflux/issues","Depends":"R (>= 3.5)","Imports":"dplyr (>= 1.0.0), dygraphs, ggplot2 (>= 3.0.0), lubridate,\nrlang (>= 0.2.0), tidyr, tsibble (>= 0.9.0), xts, zoo","Suggests":"brolgar, covr, fabletools, feasts, knitr, lifecycle, purrr,\nrmarkdown, stats, testthat (>= 3.0.0), utils","VignetteBuilder":"knitr","Config/testthat/edition":"3","Encoding":"UTF-8","Language":"en-US","LazyData":"true","RoxygenNote":"7.1.2","NeedsCompilation":"no","Packaged":"2021-11-04 19:43:44 UTC; atsyp","Author":"Anatoly Tsyplenkov [cre, aut] ()","Repository":"CRAN","Date/Publication":"2021-11-05 13:50:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/loadflux_0.0.2.tar.gz","jsonAuthors":[{"name":"Anatoly Tsyplenkov","email":"atsyplenkov@gmail.com","maintainer":true}],"readme":"\n\n\n# loadflux

\n\n\n\n[![codecov](https://codecov.io/gh/atsyplenkov/loadflux/branch/master/graph/badge.svg?token=DI1DCJV15D)](https://app.codecov.io/gh/atsyplenkov/loadflux/)\n[![R-CMD-check](https://github.com/atsyplenkov/loadflux/workflows/R-CMD-check/badge.svg)](https://github.com/atsyplenkov/loadflux/actions/)\n[![Project Status: Active – The project has reached a stable, usable\nstate and is being actively\ndeveloped.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active/)\n\n\nThe `loadflux` package is build for the comprehensive analysis of the\nintra-event suspended sediment dynamics.\n\n## Installation\n\n\n\nYou can install the development version from\n[GitHub](https://github.com/atsyplenkov/loadflux/) with:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"atsyplenkov/loadflux\")\n```\n\n## Example\n\nThis is a basic example which shows you how to split your series into\nhydrological events:\n\n``` r\nlibrary(dplyr)\nlibrary(loadflux)\ndata(djan)\n\ndf <- djan %>% \n hydro_events(q = discharge,\n datetime = time,\n window = 21)\n\nhead(df)\n#> # A tibble: 6 x 4\n#> he time discharge SS\n#> \n#> 1 1 2017-06-06 12:00:00 0.778 227.\n#> 2 1 2017-06-06 13:00:00 0.778 NA \n#> 3 1 2017-06-06 14:00:00 0.778 224.\n#> 4 1 2017-06-06 15:00:00 0.778 NA \n#> 5 1 2017-06-06 16:00:00 0.778 271.\n#> 6 1 2017-06-06 17:00:00 0.925 NA\n```\n\n### Plots\n\nThen you can plot the hysteresis loop by running `hysteresis_plot`\n\n``` r\nlibrary(ggplot2)\n\ndf %>% \n filter(he == 2) %>%\n hysteresis_plot(q = discharge,\n ssc = SS,\n base_font_size = 14)\n```\n\n

\n\n### Hyseteresis indexes\n\nThis package also contains several function for hysteresis index\ncalculation:\n\n**Added**\n\n- `SHI` - Simple Hystersis Index from [*Tsyplenkov et al.,\n 2020*](https://link.springer.com/article/10.1007/s11368-020-02633-z/)\n- `AHI` - Aich’s Hysteresis Index from [*Aich et al.,\n 2014*](https://www.sciencedirect.com/science/article/abs/pii/S0341816214001969/)\n\n**Pending**\n\n- `HImid` - Hysteresis Index from [*Lawler et al.,\n 2006*](https://www.sciencedirect.com/science/article/abs/pii/S0048969705005711/)\n\nTo calculate a hysteresis index for your event run as follows:\n\n``` r\ndf %>% \n filter(he == 2) %>% \n SHI(q = discharge,\n ssc = SS)\n#> [1] 0.2473604\n```","jobInfo":{"package":"loadflux","version":"0.0.2","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-11-05T15:30:00+0000"}}

Description

Usage

Arguments

Format

References

Examples