HydroRun-class: Class "HydroRun" and "HydroModel" (to be merged)

In RHydro: Classes and methods for hydrological modelling and analysis

Description

The HydroRun class is capable of holding data for several simulation runs

Objects from the Class

Objects are created by calling a hydrological model implemented in R or an import routine for hydrological modelling results from an external model.

Objects from this class provide common plotting and evaluation functionality. Time series can be plotted for representations: rainfall-runoff-plots, plots sorted by data type or by station and time series that help to check the mass or energy balance. Further evaluation methods will be added in future versions.

Slots

parameters:

Object of class HydroModelParameters

GIS:

ToDo

metadata:

data.frame with columns "ID", "param.ID", "GIS.ID", "type", "name", "flux", "origin", "dimension", and "run.ID"

ts:

ToDo

performanceMeasures:

"data.frame" of performance measures - one data set each run.

modelSupportData:

List of additional data required for the model to run - usually spatial data

call:

Call that returned this object

Methods

plot

signature(x = "HydroRun", y = "ANY"): see ToDo for more details.

print

signature(x = "HydroRun"): ...

predict

signature(x = "HydroModel"): ...

get.names

signature(object = "HydroRun"): Obtain list of names that can be accessed with $

subset

signature(x = "HydroRun"): select a subset of the data ToDo: Improve documentation

validitiy.check

signature(x = "HydroRun"): run validity checks on data ToDo: implement and improve documentation

NSeff

signature(x = "HydroRun", y="missing"): Return the NSeff for the HydroRun Object.

Implementation Details

ToDo How are multiple runs stored, how does it work with different data sets, what are reserved data.types

Author(s)

Dominik Reusser, Wouter Buytaert

References

thePaper

See Also

HydroRun.details,topmodel

Examples

showClass("HydroRun")

data(huagrahuma)
attach(huagrahuma)

output <- topmodel(parameters[1:9], inputs, topidx, delay)

detach(huagrahuma)

## Not run: 
library(RHydroWasimData)
file=system.file("controllfile.$$$", package="RHydroWasimData")

object <- wasim.read.Run(file)
class(object)
plot(object, hydro.plot.type="rainfall-runoff")
show(object)
print(object)
summary(object)

## End(Not run)

RHydro documentation built on May 2, 2019, 6:24 p.m.