Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
^pkgdown$
^\.github$
^vignettes/articles$
^Results$
File renamed without changes.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ inst/doc
/full_uncert_testing/
dev
rfaR_results
Results/
30 changes: 18 additions & 12 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
15 changes: 12 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 0 additions & 9 deletions LICENSE.note

This file was deleted.

8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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

Expand Down
10 changes: 8 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
133 changes: 133 additions & 0 deletions docs/CONTRIBUTING.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 12 additions & 3 deletions docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading