README.md

In iembry-USGS/FEWSR: FEWS Multiplant Model

FEWSR

R package that contains the FEWS river, lake, and pond models used to obtain the evapotranspiration from surface waters in power plants.

Development version installation

if (!requireNamespace("devtools")) {

install.packages("devtools")

}

devtools::install_github("iembry-USGS/FEWSR", build_vignettes = TRUE)

CRAN Installation (once it is available on CRAN)

install.packages("FEWSR")

FEWSR Vignettes

# the user can view the vignettes with the following command:

browseVignettes("FEWSR")

Examples

## interactive FEWSR examples (the user selects the input file via a file dialog)

library("FEWSR")

fewsr(sheet = "Input", type = "pond", output = "csv")
# The sheet name is "Input" and the surface water is pond


fewsr(type = "river", output = "xlsx")
# The sheet number is 1 (default) and the surface water is river


fewsr(sheet = 4, type = "lake", output = "both")
# The sheet number is 4 and the surface water is lake



## non-interactive FEWSR examples (the user provides the input file)

library("FEWSR")

fewsr2(file.path(system.file("extdata", "FEWS_Pond_plants_input.xlsx",
package = "FEWSR")), type = "pond", output = "csv")
# The sheet number is 1 (default) and the surface water is pond



file <- "river_input.csv"
# it is assumed that the input file is located within your current working directory

fewsr2(file, type = "river", output = "xlsx"))
# The sheet number is 1 (default) and the surface water is river

Disclaimer

This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy

Although this software program has been used by the U.S. Geological Survey (USGS), no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.

This software is provided "AS IS."

iembry-USGS/FEWSR documentation built on May 18, 2019, 2:33 a.m.