rvn_rvi_connections {RavenR} | R Documentation |
Generate Hydrological process connections list
Description
This routine reads in a hydrologic process list from rvn_rvi_read
and generates
the list of hydrologic process connections.
Usage
rvn_rvi_connections(
rvi,
ProcConDataFile = system.file("extdata", "RavenProcessConnections.dat", package =
"RavenR")
)
Arguments
rvi |
data object generated from the |
ProcConDataFile |
(optional) path to RavenProcesConnections.dat file |
Details
Relies on a valid and up-to-date RavenProcessConnections.dat file. This file is provided with the RavenR package, but may be overridden by a more recent file if provided manually.
Value
Returns a list with two items:
connections |
a a dataframe of all of the process connections Includes the following data columns: process type, algorithm, 'from' compartment, 'to' compartment, and conditional |
AliasTable |
a table of aliases (unchanged from the supplied |
Author(s)
James R. Craig, University of Waterloo
See Also
rvn_rvi_read
to read a .rvi file and generate an rvi object, and
rvn_rvi_process_ggplot
or rvn_rvi_process_diagrammer
to plot the process network produced in this function.
See also the Raven page
Examples
rvi <- rvn_rvi_read(system.file("extdata","Nith.rvi", package="RavenR"))
rvi_conn <- rvn_rvi_connections(rvi)
head(rvi_conn$connections)
head(rvi_conn$AliasTable)