ReadPmsf: Read a 'pmsf.txt' file
In HYPEtools: Tools for Processing and Analyzing Files from the Hydrological Catchment Model HYPE
View source: R/functioncollection_import.R
ReadPmsf R Documentation
Read a 'pmsf.txt' file
Description
This is a small convenience function to import a 'partial model setup file' as integer vector into R.
Usage
ReadPmsf(filename = "pmsf.txt")
Arguments
filename
Path to and file name of the pmsf file to import. Windows users: Note that
Paths are separated by '/', not '\'.
Details
ReadPmsf imports 'pmsf.txt' files, which contain SUBIDs and are used to run only parts of a HYPE setup's domain
without having to extract a separate model setup. For details on the file format, see the
pmsf.txt online documentation.
Pmsf.txt files imported with ReadPmsf are stripped from the first value containing the total number of subcatchments
in the file. No additional attribute is added to hold this number since it can be easily obtained using length.
Value
ReadPmsf returns an integer vector.
Examples
te <- ReadGeoData(filename = system.file("demo_model", "GeoData.txt", package = "HYPEtools"))
te
HYPEtools documentation built on Sept. 11, 2024, 8:34 p.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.
View source: R/functioncollection_import.R
| ReadPmsf | R Documentation |
Read a 'pmsf.txt' file
Description
This is a small convenience function to import a 'partial model setup file' as integer vector into R.
Usage
ReadPmsf(filename = "pmsf.txt")
Arguments
filename |
Path to and file name of the pmsf file to import. Windows users: Note that Paths are separated by '/', not '\'. |
Details
ReadPmsf imports 'pmsf.txt' files, which contain SUBIDs and are used to run only parts of a HYPE setup's domain
without having to extract a separate model setup. For details on the file format, see the
pmsf.txt online documentation.
Pmsf.txt files imported with ReadPmsf are stripped from the first value containing the total number of subcatchments
in the file. No additional attribute is added to hold this number since it can be easily obtained using length.
Value
ReadPmsf returns an integer vector.
Examples
te <- ReadGeoData(filename = system.file("demo_model", "GeoData.txt", package = "HYPEtools"))
te
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.