BasinData-class {baseflow}R Documentation

Class BasinData

Description

Class used by package baseflow to store hydroclimatic data from a given catchment.

Objects from the Class

Objects can be created by calls of the form new("BasinData", ...), but it is recommended to use BasinData function to create this object.

Slots

Name:

Object of class "character" giving the name of the catchment (e.g. Seine in Paris

Dates:

Vector of "POSIXct" dates giving timestamps of measures

nbTimeStep:

Object of class "integer" giving the number of measures

P:

Vector of total precipitation of length nbTimeStep

PET:

Vector of potential evapotranspiration of length nbTimeStep

Qobs:

Vector of observed streamflow of length nbTimeStep

Methods

as.data.frame

signature(x = "BasinData"): transforms object into a data frame.

print

signature(x = "BasinData"): prints object to console

show

signature(object = "BasinData"): shows object

summary

signature(object = "BasinData"): show a summary of object

Author(s)

Pelletier and Andreassian (antoine.pelletier@irstea.fr)

References

Pelletier, A. and Andréassian, V.: Hydrograph separation: an impartial parametrisation for an imperfect method, Hydrol. Earth Syst. Sci., 24, 1171–1187, doi: 10.5194/hess-24-1171-2020, 2020

See Also

BasinData

BaseflowFilter

Examples

showClass("BasinData")

[Package baseflow version 0.13.2 Index]