rvn_hyd_read: Read in Raven Hydrograph file

In rchlumsk/RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Read in Raven Hydrograph file

Description

rvn_hyd_read is used to read in the Hydrographs.csv file produced by the modelling Framework Raven.

Usage

rvn_hyd_read(ff = NA, tzone = "UTC")

Arguments

ff	full file path to the Hydrographs.csv file
tzone	string indicating the timezone of the data in ff (default "UTC")

Details

Expects a full file path to the Hydrographs.csv file, then reads in the file using fread. The main advantage of this function is renaming the columns to nicer names and extracting the units into something much easier to read.

This function is also built to support the rvn_hyd_extract function, which uses the object created here for extracting by reference to the columns named here, for example sub24.

ff is the full file path of the Hydrographs.csv file. If the file is located in the current working directory, then simply the name of the file is sufficient.

tzone is a string indicating the timezone of the supplied Hydrographs file. The timezone provided is coded into the resulting hyd data frame using the as.POSIXct function. The timezone is provided as "UTC" by default, and should be adjusted by the user to the local time zone as needed, based on the model run.

Value

hyd	data frame from the file with standardized names

See Also

rvn_hyd_extract for extraction tools related to the rvn_hyd_read output file

Examples

# read in hydrograph sample csv data from RavenR package
ff <- system.file("extdata","run1_Hydrographs.csv", package="RavenR")

# read in Raven Hydrographs file, store into myhyd
myhyd <- rvn_hyd_read(ff)

# view contents
head(myhyd$hyd)
myhyd$units

rchlumsk/RavenR documentation built on April 19, 2024, 5:15 a.m.