initial commit

.Rbuildignore

@@ -0,0 +1,4 @@
+^.*\.Rproj$
+^\.Rproj\.user$
+^\.travis\.yml$
+^README\.Rmd$

.gitignore

@@ -0,0 +1,5 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+.DS_Store

.travis.yml

@@ -0,0 +1,4 @@
+# R for travis: see documentation at https://docs.travis-ci.com/user/languages/r
+
+language: R
+cache: packages

DESCRIPTION

@@ -0,0 +1,20 @@
+Package: rulecurve
+Title: What the Package Does (One Line, Title Case)
+Version: 0.0.0.9000
+Authors@R: 
+    person(given = "Sean",
+           family = "Turner",
+           role = c("aut", "cre"),
+           email = "sean.turner@pnnl.gov",
+           comment = c(ORCID = "0000-0003-4400-9800"))
+Description: A tool for inferring reservoir storage targets and release rules.
+License: BSD 2-Clause
+Encoding: UTF-8
+LazyData: true
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.1.0
+Suggests: 
+    testthat
+Imports: 
+    magrittr,
+    tibble

DISCLAIMER

@@ -0,0 +1,85 @@
+rulecurve
+
+Copyright (c) 2021, Battelle Memorial Institute
+
+Open source under license BSD 2-Clause
+
+Open Source Disclaimer:
+This material was prepared as an account of work sponsored by an agency of the United States Government.
+Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any
+of their employees, nor any jurisdiction or organization that has cooperated in the development of these
+materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for
+the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process
+disclosed, or represents that its use would not infringe privately owned rights.
+Reference herein to any specific commercial product, process, or service by trade name, trademark,
+manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or
+favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The
+views and opinions of authors expressed herein do not necessarily state or reflect those of the United
+States Government or any agency thereof.
+
+
+PACIFIC NORTHWEST NATIONAL LABORATORY
+operated by
+BATTELLE
+for the
+UNITED STATES DEPARTMENT OF ENERGY
+under Contract DE-AC05-76RL01830
+
+
+
+GU Acknowledgement:
+These data were produced by BATTELLE under Contract No. DE‑AC05-76RL01830 with the U.S. Department of Energy (DOE).
+For a five-year period from October 31, 2014, the U.S. Government is granted for itself and others acting on
+its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative
+works, and perform publicly and display publicly, by or on behalf of the U.S. Government.  There is provision
+for the possible extension of the term of this license.  Subsequent to that period or any extension granted,
+the U.S. Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable
+worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform
+publicly and display publicly, and to permit others to do so.  The specific term of the license can be identified
+by inquiry made to BATTELLE or DOE.  Neither the United States nor DOE, nor any of their employees, makes any
+warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness,
+or usefulness of any data, apparatus, product, or process disclosed, or represents that its use would not
+infringe privately owned rights.
+
+Disclaimer:
+This Agreement is entered into by BATTELLE in its private capacity.  It is understood and agreed that the
+U.S. Government is not a party to this Agreement and in no manner whatsoever shall be liable for nor assume
+any responsibility or obligation for any claim, cost or damages arising out of or resulting from this Agreement
+or the subject matter licensed.
+LICENSEE recognizes that the Licensed Software is provided by BATTELLE on an as-is basis.  Nothing in this
+Agreement shall be deemed to be a representation or warranty by BATTELLE, or the U.S. Government, of the
+accuracy, safety or usefulness for any purpose, of the Licensed Software at any time made available by BATTELLE.
+Neither the U.S. Government nor BATTELLE nor any affiliated company of BATTELLE shall have any liability
+whatsoever to LICENSEE or any other person for or on account of any injury, loss, or damage, of any kind or
+nature sustained by, or any damage assessed or asserted against, or any other liability incurred by or imposed
+upon LICENSEE or any other person, arising out of or in connection with or resulting from (i) the production,
+use or sale of the Licensed Software or any apparatus or product, or process; (ii) the use of any technical
+information, techniques, or practices disclosed by BATTELLE; or (iii) any advertising or other promotional
+activities with respect to any of the foregoing, and LICENSEE shall hold the U.S. Government, BATTELLE, and
+any affiliated company of BATTELLE, harmless in the event the U.S. Government, BATTELLE, or any affiliated
+company of BATTELLE, is held liable.  In the event BATTELLE is determined to be liable to LICENSEE for any
+reason arising out of this Agreement, despite the above limitation, the maximum extent of BATTELLE's liability
+shall be the license fee.
+BATTELLE represents that it has the right to grant all of the rights granted herein, except as to such rights as
+the Government of the United States of America may have or may assert.
+
+Enduser Terms:
+This Agreement is entered into by BATTELLE in its private capacity.  It is understood and agreed that the
+U.S. Government is not a party to this Agreement and in no manner whatsoever shall be liable for nor assume
+any responsibility or obligation for any claim, cost or damages arising out of or resulting from this Agreement
+or the subject matter licensed.
+LICENSEE recognizes that the Licensed Software is provided by BATTELLE on an as-is basis.  Nothing in this
+Agreement shall be deemed to be a representation or warranty by BATTELLE, or the U.S. Government, of the accuracy,
+safety or usefulness for any purpose, of the Licensed Software at any time made available by BATTELLE.  Neither
+the U.S. Government nor BATTELLE nor any affiliated company of BATTELLE shall have any liability whatsoever to
+LICENSEE or any other person for or on account of any injury, loss, or damage, of any kind or nature sustained
+by, or any damage assessed or asserted against, or any other liability incurred by or imposed upon LICENSEE or
+any other person, arising out of or in connection with or resulting from (i) the production, use or sale of the
+Licensed Software or any apparatus or product, or process; (ii) the use of any technical information, techniques,
+or practices disclosed by BATTELLE; or (iii) any advertising or other promotional activities with respect to
+any of the foregoing, and LICENSEE shall hold the U.S. Government, BATTELLE, and any affiliated company of
+BATTELLE, harmless in the event the U.S. Government, BATTELLE, or any affiliated company of BATTELLE, is held
+liable.  In the event BATTELLE is determined to be liable to LICENSEE for any reason arising out of this
+Agreement, despite the above limitation, the maximum extent of BATTELLE's liability shall be the license fee.
+BATTELLE represents that it has the right to grant all of the rights granted herein, except as to such rights as
+the Government of the United States of America may have or may assert.

LICENSE

@@ -0,0 +1,28 @@
+rulecurve
+
+Copyright (c) 2021, Battelle Memorial Institute
+
+Open source under license BSD 2-Clause
+
+All rights reserved.
+
+1.	Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity
+lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”)
+to redistribute and use the Software in source and binary forms, with or without modification.  Such person
+or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and may permit others to do so, subject to the following conditions:
+
+•	Redistributions of source code must retain the above copyright notice, this list of conditions and the
+following disclaimers.
+•	Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+following disclaimer in the documentation and/or other materials provided with the distribution.
+•	Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form
+whatsoever without the express written consent of Battelle.
+
+2.	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 BATTELLE OR CONTRIBUTORS 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.

NAMESPACE

@@ -0,0 +1,5 @@
+# Generated by roxygen2: do not edit by hand
+
+export("%>%")
+importFrom(magrittr,"%>%")
+importFrom(tibble,tibble)

R/rulecurve-package.R

@@ -0,0 +1,9 @@
+#' @keywords internal
+"_PACKAGE"
+
+# The following block is used by usethis to automatically manage
+# roxygen namespace tags. Modify with care!
+## usethis namespace: start
+#' @importFrom tibble tibble
+## usethis namespace: end
+NULL

R/utils-pipe.R

@@ -0,0 +1,11 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+NULL

README.Rmd

@@ -0,0 +1,32 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# rulecurve
+
+<!-- badges: start -->
+[![Travis build status](https://travis-ci.com/IMMM-SFA/rulecurve.svg?branch=master)](https://travis-ci.com/IMMM-SFA/rulecurve)
+<!-- badges: end -->
+
+The goal of rulecurve is to ...
+
+## Installation
+
+
+Install `rulecurve` using `devtools`:
+
+``` r
+devtools::install_github("IMMM-SFA/rulecurve")
+```
+

README.md

@@ -0,0 +1,20 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# rulecurve
+
+<!-- badges: start -->
+
+[![Travis build
+status](https://travis-ci.com/IMMM-SFA/rulecurve.svg?branch=master)](https://travis-ci.com/IMMM-SFA/rulecurve)
+<!-- badges: end -->
+
+The goal of rulecurve is to …
+
+## Installation
+
+Install `rulecurve` using `devtools`:
+
+``` r
+devtools::install_github("IMMM-SFA/rulecurve")
+```

inst/CITATION

@@ -0,0 +1,16 @@
+citHeader("To cite rulecurve in publications use:")
+
+citEntry(
+  entry    = "Article",
+  title    = ,
+  author   = ,
+  journal  = ,
+  year     = ,
+  volume   = ,
+  number   = ,
+  pages    = ,
+  url      = ,
+  textVersion = paste(
+
+  )
+)

rulecurve.Rproj

@@ -0,0 +1,21 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace

tests/testthat/test-something.R

@@ -0,0 +1,3 @@
+test_that("multiplication works", {
+  expect_equal(2 * 2, 4)
+})

tests/testthat/test-tests.R

@@ -0,0 +1,3 @@
+test_that("multiplication works", {
+  expect_equal(2 * 2, 4)
+})