diff --git a/.Rbuildignore b/.Rbuildignore index f8fcb1c..a2f6c1f 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -10,3 +10,4 @@ ^pkgdown$ ^\.github$ ^vignettes/articles$ +^Results$ diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index 1d5fa81..7494f3e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ inst/doc /full_uncert_testing/ dev rfaR_results +Results/ diff --git a/DESCRIPTION b/DESCRIPTION index 1435fbe..702e3ea 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,24 +2,30 @@ Package: rfaR Title: RMC Reservoir Frequency Analysis in R Version: 0.5.1 Authors@R: c( - person("Daniel", "McGraw", , "daniel.e.mcgraw@usace.army.mil", - role = c("aut", "cre"), comment = "P.E., USACE RMC"), - person("Andrew", "Verdin", , "andrew.p.verdin@usace.army.mil", - role = "aut", comment = "PhD, P.H., USACE RMC"), - person("C. Haden", "Smith", , "cole.h.smith@usace.army.mil", - role = "aut", comment = "P.E., USACE RMC"), + person("Daniel", "McGraw", , "daniel.e.mcgraw@usace.army.mil", + role = c("aut", "cre"), + comment = c("P.E., USACE RMC", ORCID = "0009-0006-4859-0179")), + person("Andrew", "Verdin", , "andrew.p.verdin@usace.army.mil", + role = "aut", + comment = c("PhD, P.H., USACE RMC", ORCID = "0000-0003-1967-9626")), + person("C. Haden", "Smith", , "cole.h.smith@usace.army.mil", + role = "aut", + comment = c("P.E., USACE RMC", ORCID = "0000-0002-4651-9890")), person("Allen", "Avance", , "allen.avance@usace.army.mil", role = "ctb", comment = "P.E., USACE RMC"), person("Samantha", "Hartke", , "samantha.h.hartke@usace.army.mil", - role = "ctb", comment = "PhD, USACE RMC"), + role = "ctb", + comment = c("PhD, USACE RMC", ORCID = "0000-0002-0239-4723")), person("Julian", "Gonzalez", , "julian.t.gonzalez@usace.army.mil", - role = "ctb", comment = "USACE RMC"), + role = "ctb", + comment = c("USACE RMC", ORCID = "0009-0009-9058-7653")), person("Sadie", "Niblett", , "sadie.s.niblett@usace.army.mil", - role = "rev", comment = "USACE RMC"), + role = "rev", + comment = c("USACE RMC", ORCID = "0009-0008-8588-4816")), person("Reuben", "Sasaki", , "reuben.a.sasaki@usace.army.mil", - role = "rev", comment = "P.E.,USACE RMC"), + role = "rev", comment = "P.E., USACE RMC"), person("Bryan", "Robinson", , "bryan.j.robinson@usace.army.mil", - role = "rev", comment = "P.E.,USACE RMC")) + role = "rev", comment = "P.E., USACE RMC")) Description: An R implementation of the U.S. Army Corps of Engineers (USACE) Risk Management Center-Reservoir Frequency Analysis (RMC-RFA) methodology/software. This package produces reservoir stage-frequency curves with uncertainty bounds @@ -33,7 +39,7 @@ Description: An R implementation of the U.S. Army Corps of Engineers (USACE) parameters (stage, discharge, duration) and their associated annual exceedance probabilities. Nickname: Friday -License: BSD_3_clause + file LICENSE +License: file LICENSE URL: https://github.com/USACE-RMC/rfaR, https://usace-rmc.github.io/rfaR/ BugReports: https://github.com/USACE-RMC/rfaR/issues Encoding: UTF-8 diff --git a/LICENSE b/LICENSE index 6d52d3c..e2a8ac7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,12 @@ -YEAR: 2024 -COPYRIGHT HOLDER: US Army Corps of Engineers - Risk Management Center -ORGANIZATION: US Army Corps of Engineers - Risk Management Center +Copyright (C) 2026 by U.S. Army Corps of Engineers - Risk Management Center + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENSE.note b/LICENSE.note deleted file mode 100644 index 1de16b3..0000000 --- a/LICENSE.note +++ /dev/null @@ -1,9 +0,0 @@ -NOTICE: -The U.S. Army Corps of Engineers, Risk Management Center (USACE-RMC) makes no guarantees about the results, or appropriateness of outputs, obtained from rfaR. -LIST OF CONDITIONS: -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above notice, this list of conditions, and the following disclaimer. -* Redistributions in binary form must reproduce the above notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution. -* The names of the U.S. Government, the U.S. Army Corps of Engineers, the Institute for Water Resources, or the Risk Management Center may not be used to endorse or promote products derived from this software without specific prior written permission. Nor may the names of its contributors be used to endorse or promote products derived from this software without specific prior written permission. -DISCLAIMER: -THIS SOFTWARE IS PROVIDED BY THE U.S. ARMY CORPS OF ENGINEERS RISK MANAGEMENT CENTER (USACE-RMC) "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL USACE-RMC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE diff --git a/README.md b/README.md index 53cdc87..02935e6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # rfaR -> [!WARNING] -> This package is currently under active development. The API may change without notice. +> **NOTE** This package is currently under active development. The API may change without notice. -[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![R](https://img.shields.io/badge/R-%3E%3D4.1-blue)](https://cran.r-project.org/) [![License](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE) +[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![R](https://img.shields.io/badge/R-%3E%3D4.1-blue)](https://cran.r-project.org/) [![License: 0BSD](https://img.shields.io/badge/License-0BSD-blue.svg)](https://opensource.org/licenses/0BSD) An R implementation of the U.S. Army Corps of Engineers (USACE) Risk Management Center-Reservoir Frequency Analysis (RMC-RFA) methodology/software. This package produces reservoir stage-frequency curves with uncertainty bounds by combining deterministic flood routing (Modified Puls method) with a nested Monte Carlo framework — providing H&H engineers the tools needed for dam safety risk assessments in accordance with USACE/RMC guidance. @@ -40,8 +39,7 @@ devtools::load_all() devtools::install() ``` -> [!NOTE] -> Cloning the repository alone does not make `library(rfaR)` work — the package must be either installed (`devtools::install()` or `remotes::install_github()`) or loaded into the session via `devtools::load_all()`. A cloned repo on disk is source code, not an installed package. +> **NOTE** Cloning the repository alone does not make `library(rfaR)` work — the package must be either installed (`devtools::install()` or `remotes::install_github()`) or loaded into the session via `devtools::load_all()`. A cloned repo on disk is source code, not an installed package. ## Example Data diff --git a/_pkgdown.yml b/_pkgdown.yml index 44b8823..f44f34c 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,8 +1,14 @@ url: https://usace-rmc.github.io/rfaR/ template: bootstrap: 5 - bootswatch: flatly - light-switch: true + bootswatch: yeti + light-switch: false +home: + title: "rfaR — Reservoir Frequency Analysis" + description: "Stratified Monte Carlo stage-frequency analysis for dam & levee safety applications" + links: + - text: USACE Risk Management Center + href: https://www.rmc.usace.army.mil/Software/RMC-RFA/ navbar: structure: left: [intro, reference, articles, news] diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html new file mode 100644 index 0000000..58180ec --- /dev/null +++ b/docs/CONTRIBUTING.html @@ -0,0 +1,133 @@ + +Contributing to rfaR • rfaR + Skip to contents + + +
+
+
+ +

Contributing to rfaR

+ Source: .github/CONTRIBUTING.md +
+ +
+ +

Thank you for your interest in contributing to rfaR! We welcome bug reports, feature requests, validation results, and other feedback from the community.

+
+

Review Capacity

+

rfaR is maintained by a small team within the U.S. Army Corps of Engineers Risk Management Center (USACE-RMC). Our capacity to review external pull requests is very limited. We prioritize issues and bug reports, which are always welcome and will be reviewed as resources permit.

+

If you plan to submit a pull request, please open an issue first to discuss your proposed change. This helps avoid duplicated effort and ensures your contribution aligns with the project’s direction.

+
+
+

How to Contribute

+
+

Report a Bug

+

If you find a bug, please open an issue and include:

+
  • Steps to reproduce the problem
    • +
  • Input data and configuration (if applicable)
    • +
  • Expected behavior vs. actual behavior
    • +
  • R version, rfaR version (packageVersion("rfaR")), and operating system
    • +
  • Any relevant error messages or screenshots
    • +
  • A minimal reproducible example (reprex) when possible
    • +
+
+

Request a Feature

+

Feature requests are welcome. Please open an issue describing:

+
  • The use case or problem you are trying to solve
    • +
  • How you envision the feature working
    • +
  • Any references to statistical or hydrologic methods or published literature
    • +
+
+

Report Validation Results

+

Given the life-safety applications of this software, independent validation is especially valuable. If you have compared rfaR results against other software (e.g., RMC-RFA, HEC-HMS, HEC-WAT, published tables, or analytical solutions), we would appreciate hearing about it through an issue.

+
+
+

Submit a Pull Request

+

Pull requests may take several weeks or longer to review. Before submitting code:

+
  1. +Open an issue first to discuss the proposed change
    2. +
  2. +Follow the coding standards, including roxygen2 documentation on all exported functions
    3. +
  3. +Include unit tests using testthat that validate against known results (RMC-RFA, HEC-HMS, published tables, or analytical solutions)
    4. +
  4. +Ensure a clean R CMD check with zero errors, zero warnings, and zero notes (run via devtools::check())
    5. +
  5. +Rebuild documentation with devtools::document() before committing
    6. +
  6. +Follow existing code style (explicit package::function() namespacing, positional column access where appropriate, and the package’s established plotting conventions)
    7. +
+
+
+

Developer Certificate of Origin

+

By submitting a pull request, you certify under the Developer Certificate of Origin (DCO) Version 1.1 that you have the right to submit the work under the license associated with this project and that you agree to the DCO.

+

All contributions will be released under the same license as the project (see LICENSE).

+
+
+

Federal Government Contributors

+

U.S. Federal law prevents the government from accepting gratuitous services unless certain conditions are met. By submitting a pull request, you acknowledge that your services are offered without expectation of payment and that you expressly waive any future pay claims against the U.S. Federal government related to your contribution.

+

If you are a U.S. Federal government employee and use a *.mil or *.gov email address, your contribution is understood to have been created in whole or in part as part of your official duties and is not subject to domestic copyright protection under 17 USC 105.

+
+
+

Security

+

If you discover a security vulnerability, please do not open a public issue. Instead, contact the RMC team directly through official USACE-RMC channels.

+
+
+

License

+

See LICENSE for details. This software is provided by USACE-RMC under a BSD-3-Clause license with a no-endorsement clause.

+
+
+ +
+ + +
+ + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index db62aea..984713d 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -43,9 +43,18 @@

License

-
YEAR: 2024
-COPYRIGHT HOLDER: US Army Corps of Engineers - Risk Management Center
-ORGANIZATION: US Army Corps of Engineers - Risk Management Center
+
Copyright (C) 2026 by U.S. Army Corps of Engineers - Risk Management Center
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 

 
   
diff --git a/docs/authors.html b/docs/authors.html
index b2ec34f..22ed081 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -46,15 +46,15 @@ 
Authors and Citation

       
Authors

 
       
 
     

@@ -86,7 +98,7 @@ 
Citation

   organization = {U.S. Army Corps of Engineers, Risk Management Center},
   address = {Lakewood, CO},
   year = {2026},
-  version = {0.1.3},
+  version = {0.5.1},
   url = {https://github.com/USACE-RMC/rfaR},
 }
diff --git a/docs/index.html b/docs/index.html index 237a64b..3589520 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,20 +5,20 @@ -RMC Reservoir Frequency Analysis in R • rfaR - +rfaR — Reservoir Frequency Analysis • rfaR + - - - + + + Skip to contents -