createBasin.default: default function for class of 'createBasin'

Description Usage Arguments Value Author(s) See Also

View source: R/createBasin.default.R

Description

instantiates an object from class of createBasin

Usage

1
2
## Default S3 method:
createBasin(name = "Untittled", simulation=list(start=NULL,end=NULL,by=NULL))

Arguments

name

a string: a name for the basin

simulation

a list of simulation time and dates as below:

  • start: the date which simulation starts, must be in 'YYYY-MM-DD' format

  • start: the date which simulation ends, must be in 'YYYY-MM-DD' format

  • by: the interval of each steps in seconds

Value

a list: an object from class of creatBasin

Author(s)

Rezgar Arabzadeh

See Also

addObjectToBasin


RHMS documentation built on Sept. 27, 2021, 5:06 p.m.