{"id":22798044,"url":"https://github.com/doi-usgs/loadflex","last_synced_at":"2025-04-19T15:13:09.188Z","repository":{"id":24737040,"uuid":"28149424","full_name":"DOI-USGS/loadflex","owner":"DOI-USGS","description":"Models and Tools for Watershed Flux Estimates","archived":false,"fork":false,"pushed_at":"2024-12-06T16:13:12.000Z","size":5436,"stargazers_count":14,"open_issues_count":59,"forks_count":17,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-03-29T09:12:17.058Z","etag":null,"topics":["r","rstats","usgs","water-quality","watershed-flux-estimates"],"latest_commit_sha":null,"homepage":"http://dx.doi.org/10.1890/ES14-00517.1","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DOI-USGS.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2014-12-17T18:17:09.000Z","updated_at":"2025-02-17T09:26:27.000Z","dependencies_parsed_at":"2023-09-12T11:52:30.187Z","dependency_job_id":null,"html_url":"https://github.com/DOI-USGS/loadflex","commit_stats":null,"previous_names":["doi-usgs/loadflex","usgs-r/loadflex"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DOI-USGS%2Floadflex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DOI-USGS%2Floadflex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DOI-USGS%2Floadflex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DOI-USGS%2Floadflex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DOI-USGS","download_url":"https://codeload.github.com/DOI-USGS/loadflex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249723818,"owners_count":21316115,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["r","rstats","usgs","water-quality","watershed-flux-estimates"],"created_at":"2024-12-12T06:08:01.220Z","updated_at":"2025-04-19T15:13:09.156Z","avatar_url":"https://github.com/DOI-USGS.png","language":"R","readme":"---\ntitle: \"README\"\noutput:\n  md_document:\n    variant: markdown_github\neditor_options: \n  chunk_output_type: console\n---\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"##\",\n  fig.path = \"man/figures/README-\"\n)\n```\n\n# loadflex: Models and Tools for Watershed Flux Estimates\n\n\u003cspan style=\"color: red;\"\u003e\nIn summer or fall 2023, this package will move from\nhttps://github.com/USGS-R/loadflex to\nhttps://github.com/DOI-USGS/loadflex\nPlease update your links accordingly.\n\u003c/span\u003e\n\nThe `loadflex` R package implements several of the most common methods for modeling and\npredicting watershed solute fluxes and concentrations, including interpolation\nand regression models, period-weighted averaging, and the composite method.\n`loadflex` integrates seamlessly with the USGS's\n[rloadest](https://code.usgs.gov/water/analysis-tools/rloadest) package and with native R\nregression models. It offers a uniform interface for any model type, with which\nyou can quickly fit models, generate predictions, and aggregate to monthly or\nannual values.\n\nThis package has been described in Appling et al. (2015):\n\n\u003e Appling, A. P., Leon, M. C., \u0026 McDowell, W. H. (2015). Reducing bias and quantifying uncertainty in watershed flux estimates: The R package `loadflex`. Ecosphere, 6(12), art269. https://doi.org/10.1890/ES14-00517.1\n\n\nTo see the recommended citation for this package, please run `citation('loadflex')` at the R prompt.\n```{r eval=TRUE}\ncitation('loadflex')\n```\n\n## Installation\n\nTo install the `loadflex` package, use the `remotes` package as follows (running `install.packages('remotes')` first if needed). To use `remotes::install_gitlab()` it is convenient to set a [GitLab Personal Access Token (PAT)](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html). Similarly, to use `remotes::install_github()` it is convenient to set a [GitHub PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). There are [several methods](https://usethis.r-lib.org/articles/git-credentials.html) for setting your PATs within R; the simplest is to call `Sys.setenv(GITLAB_PAT=\"xxxx\", GITHUB_PAT=\"yyyy\"),\nreplacing xxxx and yyyy with the PATs you established on the GitLab and GitHub websites.\n\nYou will also need a compiler to install `smwrStats`, `smwrQW`, and `rloadest` -- for Windows, see https://cran.r-project.org/bin/windows/Rtools/rtools43/rtools.html. For Mac, see https://mac.r-project.org/tools/.\n\n```{r eval=FALSE}\nlibrary(remotes)\nremotes::install_gitlab(\"water/analysis-tools/smwrData\", host = \"code.usgs.gov\")\nremotes::install_gitlab(\"water/analysis-tools/smwrBase\", host = \"code.usgs.gov\")\nremotes::install_gitlab(\"water/analysis-tools/smwrGraphs\", host = \"code.usgs.gov\")\nremotes::install_gitlab(\"water/analysis-tools/smwrStats\", host = \"code.usgs.gov\") # needs compilation\nremotes::install_gitlab(\"water/analysis-tools/smwrQW\", host = \"code.usgs.gov\")    # needs compilation\nremotes::install_gitlab(\"water/analysis-tools/rloadest\", host = \"code.usgs.gov\")  # needs compilation\nremotes::install_github(\"appling/unitted\")\nremotes::install_github(\"DOI-USGS/EGRET\")\nremotes::install_github(\"USGS-R/loadflex\") # soon to be \"DOI-USGS/loadflex\"\n```\n\nAlso please see the installation FAQ on the wiki\n(https://github.com/USGS-R/loadflex/wiki/Installation-FAQ) if you run into trouble.\n\n\n## Getting Started\n\nTo get started, load the package with `library(loadflex)` and type `?loadflex` or `vignette('intro_to_loadflex')`.\n\n\n## Development and Maintenance Status\n\n`loadflex` is a USGS Archive Research Package:\n[![USGS Status](https://img.shields.io/badge/USGS-Research-blue.svg)](https://owi.usgs.gov/R/packages.html#research)\n\nProject funding has ended and our maintenance time is limited,\nbut we do attempt to provide bug fixes and lightweight support\nas we are able. Submit questions or suggestions to\n[https://github.com/USGS-R/loadflex/issues](https://github.com/USGS-R/loadflex/issues).\n\n\n## Contributing\n\nWe want to encourage a warm, welcoming, and safe environment for contributing to this project. See [CODE_OF_CONDUCT.md](https://github.com/USGS-R/streamMetabolizer/blob/main/CODE_OF_CONDUCT.md) for more information.\n\nFor technical details on how to contribute, see [CONTRIBUTING.md](https://github.com/USGS-R/streamMetabolizer/blob/main/CONTRIBUTING.md)\n\n\n## Contributing\n\nWe want to encourage a warm, welcoming, and safe environment for contributing to this project. See [CODE_OF_CONDUCT.md](https://github.com/USGS-R/loadflex/blob/main/CODE_OF_CONDUCT.md) for more information.\n\nFor technical details on how to contribute, see [CONTRIBUTING.md](https://github.com/USGS-R/loadflex/blob/main/CONTRIBUTING.md)\n\n\n## Development History\n\n`loadflex` was created 2013-2015 by [Alison Appling](https://github.com/aappling-usgs) \nand [Miguel Leon](https://github.com/miguelcleon) with the support of [Bill \nMcDowell](https://colsa.unh.edu/faculty/mcdowell) and the [McDowell \nlab](http://wrrc.unh.edu/mcdowell-lab-current) at the University of New \nHampshire. Funding for the project was provided by the National \nScience Foundation, USDA National Institute of Food and Agriculture, and the NH \nAgricultural Experiment Station. Funding for the example dataset from the \nLamprey River was provied by the EPA, NH Water Resources Research Center, NH \nAgricultural Experiment Station, NH Sea Grant, USGS, and NSF.\n\nAdditional development and maintenance in 2016-2017 was done by \n[Alison Appling](https://github.com/aappling-usgs),\n[Lindsay Platt](https://github.com/lindsayplatt), and\n[David Watkins](https://github.com/wdwatkins) with support from the USGS National Water Quality Program and the USGS Office of Water Information.\n\n\n## Model Archive\n\nThe following version of R and package dependencies were used most recently to pass the embedded tests within this package. There is no guarantee of reproducible results using future versions of R or updated versions of package dependencies; however, we aim to test and update future modeling environments.\n\n\u003c!-- Run and paste manually after edits, only when tests pass locally --\u003e\n```{r eval=FALSE}\n\u003e sessioninfo::session_info()\n\n## (TBD)\n```\n\n\n```{r disclaimer, child=\"DISCLAIMER.md\", eval=TRUE}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoi-usgs%2Floadflex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoi-usgs%2Floadflex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoi-usgs%2Floadflex/lists"}