Learn R Programming

foreSIGHT (version 0.9.81)

tankWrapper: A demo tank model of the format required for uses in foreSIGHT examples and vignette

Description

A demo tank model with wrapper to tailor format to foreSIGHT

Usage

tankWrapper(data=NULL,
                 systemArgs=NULL,
                 repID=NULL)

Arguments

data

A dataframe of observed climate data in the form Year Month Day P Temp.

systemArgs

a list to control the exposure space creation with the following components:

roofArea

roof area in m2

nPeople

number of people using water

tankVol

tank volume in L

firstFlush

first flush depth over roof in mm

write.file

logical. write output tank timeseries to file T/F?

fnam

string indicating name of file

metric

string indicating what metric to report: average daily deficit - "avDeficit", volumetric reliability - "volRel", reliability - "reliability", storage efficiency - "storEff", system efficiency - "sysEff"

repID

a number that is used of append file names to distiguish between replicates.