ReadPmsf: Read a 'pmsf.txt' file

View source: R/functioncollection_import.R

ReadPmsfR 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


rcapell/RHYPE documentation built on Feb. 28, 2024, 3:11 p.m.