DWBmodelUN (version 1.0.0)

readSetup: Read the model setup

Description

This function reads the setup features of the model. These include the dates that define the simulated time period, and also the variables that will be printed in individual directories. It reads the information from a RData file, and returns the identified variables in a tailored dataframe. Optionally, one can insert the string setup in a dataframe and hence use it in this function.

Usage

readSetup(Read = TRUE, setup)

Arguments

Read

is a boolean which is used to identify whether the modeller has created its own dataframe in R or the setup is read from file previously written in the data directory. An example of the file is contained in the package. The default value is TRUE, meaning that it will read the plain file from the data directory.

setup

is an optional dataframe that contains the character strings which specifies dates and variables to be printed. The first seven rows must be character strings specifying the actions regarding if the modeller requires to print the simulated variables. The order is: calibration mode, print variables, print total runoff, print soil moisture, print actual ET, print direct runoff, print baseflow. Those strings must be YES or NO. The next four rows are: the initial date of simulation, the initial date for calibration, the final date of simulation, and the final date of calibration. This dates must be in the format year-month-day. If calibration is not required, those dates are ignored.

Value

An organized dataframe which defines the model setup.

Examples

# NOT RUN {
setup <- readSetup(Read = TRUE)  # run if you would like to upload the example setup

data(setup_data)
setup <- readSetup(Read = TRUE, setup_data)

# Create your own setup
a <- rep("no",7)
b <- "1990-01-01"
c <- "1991-01-01"
d <- "2012-12-15"
e <- "2012-12-10"
table_setup <- data.frame(set=a,stringsAsFactors = FALSE)
table_setup <- rbind(table_setup, b, c, d, e)
setup <- readSetup(Read = FALSE, table_setup)

# }