WritePmsf: Write a 'pmsf.txt' file
In rcapell/RHYPE: Tools for Processing and Analyzing Files from the Hydrological Catchment Model HYPE
View source: R/functioncollection_export.R
WritePmsf R Documentation
Write a 'pmsf.txt' file
Description
This is a small convenience function to export a 'partial model setup file' from R.
Usage
WritePmsf(x, filename)
Arguments
x
The object to be written, an integer vector containing SUBIDs.
filename
A character string naming a file to write to. Windows users: Note that
Paths are separated by '/', not '\'.
Details
Pmsf files are represented as integer vectors in R. The total number of subcatchments in the file are added as first value on export.
pmsf.txt files need to be ordered as downstream sequence.
Value
No return value, called for export to text files.
See Also
AllUpstreamSubids, which extracts upstream SUBIDs from a GeoData dataframe.
Examples
te <- ReadGeoData(filename = system.file("demo_model", "GeoData.txt", package = "HYPEtools"))
WritePmsf(x = te$SUBID[te$SUBID %in% AllUpstreamSubids(3564, te)], filename = tempfile())
rcapell/RHYPE documentation built on Feb. 28, 2024, 3:11 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_export.R
| WritePmsf | R Documentation |
Write a 'pmsf.txt' file
Description
This is a small convenience function to export a 'partial model setup file' from R.
Usage
WritePmsf(x, filename)
Arguments
x |
The object to be written, an |
filename |
A character string naming a file to write to. Windows users: Note that Paths are separated by '/', not '\'. |
Details
Pmsf files are represented as integer vectors in R. The total number of subcatchments in the file are added as first value on export. pmsf.txt files need to be ordered as downstream sequence.
Value
No return value, called for export to text files.
See Also
AllUpstreamSubids, which extracts upstream SUBIDs from a GeoData dataframe.
Examples
te <- ReadGeoData(filename = system.file("demo_model", "GeoData.txt", package = "HYPEtools"))
WritePmsf(x = te$SUBID[te$SUBID %in% AllUpstreamSubids(3564, te)], filename = tempfile())
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.