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/inst/CITATION b/inst/CITATION index 5dea8c5..7fb003b 100644 --- a/inst/CITATION +++ b/inst/CITATION @@ -1,15 +1,17 @@ +meta <- utils::packageDescription("rfaR") + citHeader("To cite rfaR:") bibentry( - bibtype = "Manual", - title = "rfaR: RMC Reservoir Frequency Analysis in R", - author = c( + bibtype = "Manual", + title = "rfaR: RMC Reservoir Frequency Analysis in R", + author = c( person("Daniel", "McGraw"), person("Andrew", "Verdin"), person("C. Haden", "Smith") ), organization = "U.S. Army Corps of Engineers, Risk Management Center", - address = "Lakewood, CO", - year = "2026", - version = "0.1.3", - url = "https://github.com/USACE-RMC/rfaR" + address = "Lakewood, CO", + year = format(Sys.Date(), "%Y"), + version = meta$Version, + url = "https://github.com/USACE-RMC/rfaR" ) diff --git a/man/rfaR-package.Rd b/man/rfaR-package.Rd index 1d24d8d..e19239b 100644 --- a/man/rfaR-package.Rd +++ b/man/rfaR-package.Rd @@ -18,22 +18,22 @@ Useful links: } \author{ -\strong{Maintainer}: Daniel McGraw \email{daniel.e.mcgraw@usace.army.mil} (P.E., USACE RMC) +\strong{Maintainer}: Daniel McGraw \email{daniel.e.mcgraw@usace.army.mil} (\href{https://orcid.org/0009-0006-4859-0179}{ORCID}) (P.E., USACE RMC) Authors: \itemize{ - \item Andrew Verdin \email{andrew.p.verdin@usace.army.mil} (PhD, P.H., USACE RMC) - \item C. Haden Smith \email{cole.h.smith@usace.army.mil} (P.E., USACE RMC) + \item Andrew Verdin \email{andrew.p.verdin@usace.army.mil} (\href{https://orcid.org/0000-0003-1967-9626}{ORCID}) (PhD, P.H., USACE RMC) + \item C. Haden Smith \email{cole.h.smith@usace.army.mil} (\href{https://orcid.org/0000-0002-4651-9890}{ORCID}) (P.E., USACE RMC) } Other contributors: \itemize{ \item Allen Avance \email{allen.avance@usace.army.mil} (P.E., USACE RMC) [contributor] - \item Samantha Hartke \email{samantha.h.hartke@usace.army.mil} (PhD, USACE RMC) [contributor] - \item Julian Gonzalez \email{julian.t.gonzalez@usace.army.mil} (USACE RMC) [contributor] - \item Sadie Niblett \email{sadie.s.niblett@usace.army.mil} (USACE RMC) [reviewer] - \item Reuben Sasaki \email{reuben.a.sasaki@usace.army.mil} (P.E.,USACE RMC) [reviewer] - \item Bryan Robinson \email{bryan.j.robinson@usace.army.mil} (P.E.,USACE RMC) [reviewer] + \item Samantha Hartke \email{samantha.h.hartke@usace.army.mil} (\href{https://orcid.org/0000-0002-0239-4723}{ORCID}) (PhD, USACE RMC) [contributor] + \item Julian Gonzalez \email{julian.t.gonzalez@usace.army.mil} (\href{https://orcid.org/0009-0009-9058-7653}{ORCID}) (USACE RMC) [contributor] + \item Sadie Niblett \email{sadie.s.niblett@usace.army.mil} (\href{https://orcid.org/0009-0008-8588-4816}{ORCID}) (USACE RMC) [reviewer] + \item Reuben Sasaki \email{reuben.a.sasaki@usace.army.mil} (P.E., USACE RMC) [reviewer] + \item Bryan Robinson \email{bryan.j.robinson@usace.army.mil} (P.E., USACE RMC) [reviewer] } }