# 'airGR' Integrated Water Resource Management

## Documentation for package ‘airGRiwrm’ version 0.7.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

as.Qm3s | Coerce data.frame or content of a data.frame into a _Qm3s_ object ready for plotting
Calibration | Calibration of the parameters of one catchment or a network of sub-catchments
Calibration.GRiwrmInputsModel | Calibration of the parameters of one catchment or a network of sub-catchments
Calibration.InputsModel | Calibration of the parameters of one catchment or a network of sub-catchments
Calibration.Ungauged | Calibration of the parameters of one catchment or a network of sub-catchments
ConvertMeteoSD | Conversion of meteorological data from basin scale to sub-basin scale
ConvertMeteoSD.character | Conversion of meteorological data from basin scale to sub-basin scale
ConvertMeteoSD.GRiwrm | Conversion of meteorological data from basin scale to sub-basin scale
ConvertMeteoSD.matrix | Conversion of meteorological data from basin scale to sub-basin scale
CreateCalibOptions | Creation of the CalibOptions object
CreateCalibOptions.character | Creation of the CalibOptions object
CreateCalibOptions.function | Creation of the CalibOptions object
CreateCalibOptions.GRiwrmInputsModel | Creation of the CalibOptions object
CreateCalibOptions.InputsModel | Creation of the CalibOptions object
CreateCalibOptions.RunModel_Reservoir | Creation of the CalibOptions object
CreateController | Creation and adding of a controller in a supervisor
CreateGRiwrm | Generation of a network description containing all hydraulic nodes and the description of their connections
CreateInputsCrit | Creation of the InputsCrit object required to the 'ErrorCrit' functions
CreateInputsCrit.GRiwrmInputsModel | Creation of the InputsCrit object required to the 'ErrorCrit' functions
CreateInputsCrit.InputsModel | Creation of the InputsCrit object required to the 'ErrorCrit' functions
CreateInputsModel | Generic function for creating 'InputsModel' object for either *airGR* or *airGRiwrm*
CreateInputsModel.default | Generic function for creating 'InputsModel' object for either *airGR* or *airGRiwrm*
CreateInputsModel.GRiwrm | Creation of an InputsModel object for a *airGRiwrm* network
CreateRunOptions | Creation of the RunOptions object
CreateRunOptions.character | Creation of the RunOptions object
CreateRunOptions.function | Creation of the RunOptions object
CreateRunOptions.GRiwrmInputsModel | Creation of the RunOptions object
CreateRunOptions.InputsModel | Creation of the RunOptions object
CreateSupervisor | Creation of a Supervisor for handling regulation in a model
extractParam | Extract calibrated parameters
getAllNodesProperties | Properties of GRiwrm nodes
getNodeProperties | Properties of GRiwrm nodes
getNodeRanking | Sorting of the nodes from upstream to downstream for RunModel and Calibration
getNoSD_Ids | Function to obtain the ID of sub-basins not using SD model
getSD_Ids | Function to obtain the ID of sub-basins using SD model
GRiwrm | Generation of a network description containing all hydraulic nodes and the description of their connections
isNodeDownstream | Check if a node is downstream or upstream another one
isNodeDownstream.GRiwrm | Check if a node is downstream or upstream another one
isNodeDownstream.GRiwrmInputsModel | Check if a node is downstream or upstream another one
isNodeUpstream | Check if a node is downstream or upstream another one
isNodeUpstream.GRiwrm | Check if a node is downstream or upstream another one
isNodeUpstream.GRiwrmInputsModel | Check if a node is downstream or upstream another one
mermaid | Plot a mermaid diagram
mermaid_gen_link | Plot a mermaid diagram
plot.GRiwrm | Plot of a diagram representing the network structure of a GRiwrm object
plot.GRiwrmOutputsModel | Function which creates screen plots giving an overview of the model outputs in the GRiwrm network
plot.mermaid | Plot a mermaid diagram
plot.OutputsModelReservoir | Plot simulated reservoir volume, inflows and released flows time series on a reservoir node
plot.Qm3s | Plot of a 'Qm3s' object (time series of simulated flows)
reduceGRiwrm | Reduce the size of a GRiwrm by selecting the subset of nodes corresponding to a downstream node
RunModel | RunModel function for both *airGR* InputsModel and GRiwrmInputsModel object
RunModel.GR | Run of a rainfall-runoff model on a sub-basin
RunModel.GRiwrmInputsModel | RunModel function for _GRiwrmInputsModel_ object
RunModel.InputsModel | Wrapper for airGR::RunModel for one sub-basin
RunModel.Supervisor | RunModel function for a GRiwrmInputsModel object
RunModel_Reservoir | Run with a reservoir model
Severn | Catchment attributes and hydro-meteorological timeseries for some gauging stations on the Severn River
sort.GRiwrm | Sort a GRiwrm network in upstream-downstream order ready for Calibration
transferGRparams | Transfer GR parameters from one donor sub-basin to a receiver sub-basin