read.msxrpt: Read msx results
In bradleyjeck/epanetReader: Read Epanet Files into R
Description
Usage
Arguments
Details
Value
References
Examples
Description
reads an Epanet-msx .rpt file into R
Usage
1
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
1
2
3
4
5
6
7
8
# 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)
bradleyjeck/epanetReader documentation built on May 13, 2019, 2:28 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value References Examples
Description
reads an Epanet-msx .rpt file into R
Usage
1 |
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
1 2 3 4 5 6 7 8 | # 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)
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.