read.msxrpt: Read msx results

In epanetReader: Read Epanet Files into R

Description

reads an Epanet-msx .rpt file into R

Usage

read.msxrpt(file)

Arguments

file	the name of the file to read

Details

Specify the needed outputs from an Epanet-msx simulation in the [REPORT] section of the .msx file to create reports for reading with with this function.

The function returns an S3 object (list) with a data.frame for node results and data.frame for link results. These data.frames contain results from all the time periods to facilitate time series plots.

Value

Returns an epanetmsx.rpt S3 object .

nodeResults	data.frame
linkResults	data.frame

References

Shang, F., Uber, J.G., Rossman, L.A. (2011) EPANET Multi-species Extension User's Manual. US Environmental Protection Agency, Cincinnati.

Examples

# path to example file included with this package
msr <- file.path( find.package("epanetReader"), "extdata","example.rpt") 

#read the results into R
x <- read.msxrpt(msr)
names(x)
summary(x)
plot(x)

Example output

[1] "Title"       "nodeResults" "linkResults"
  Water Age + temp + Cl + TTHM + HAA6  
 node results
      AGE             TEMP              CL              TTHM      
 Min.   :    0   Min.   : 5.000   Min.   :0.0000   Min.   : 0.00  
 1st Qu.: 3233   1st Qu.: 5.302   1st Qu.:0.9500   1st Qu.:15.51  
 Median : 7508   Median : 5.652   Median :1.1402   Median :23.10  
 Mean   : 8446   Mean   : 6.298   Mean   :0.9966   Mean   :19.03  
 3rd Qu.:12547   3rd Qu.: 6.023   3rd Qu.:1.3295   3rd Qu.:27.83  
 Max.   :27294   Max.   :10.000   Max.   :1.5000   Max.   :35.58  
      HAA6       
 Min.   : 0.000  
 1st Qu.: 8.280  
 Median :10.843  
 Mean   : 8.659  
 3rd Qu.:12.307  
 Max.   :14.691  
 Link results
NULL

epanetReader documentation built on May 2, 2019, 2:08 p.m.