deletePrjHRUs: Removes specified HRUs from .prj file

View source: R/deletePrjHRUs.R

deletePrjHRUsR Documentation

Removes specified HRUs from .prj file

Description

Deletes names and parameter values for the specified set of HRUs. Note that this function is very destructive, so it's a good idea to have a backup copy of your .prj file before running it!

Usage

deletePrjHRUs(
  inputPrjFile = NULL,
  deletedHRUs = NULL,
  outputPrjFile = NULL,
  quiet = TRUE,
  logfile = ""
)

Arguments

inputPrjFile

Required. Name of the .prj file to read.

deletedHRUs

Required. Vector of HRU numbers to delete.

outputPrjFile

Optional. If omitted, the input .prj file will be overwritten.

quiet

Optional. Suppresses display of messages, except for errors. If you are calling this function in an R script, you will usually leave quiet=TRUE (i.e. the default). If you are working interactively, you will probably want to set quiet=FALSE.

logfile

Optional. Name of the file to be used for logging the action. Normally not used

Value

If successful, returns TRUE. If unsuccessful, returns FALSE.

Note

Currently, this function has only been tested on simple .prj files, i.e. without REW Grp parameters.

Author(s)

Kevin Shook

See Also

replacePrjParameters

Examples

## Not run: 
result <- deletePrjParameters("CRHM/Bad74_Frozen.prj", c(3, 5, 7)
## End(Not run)


CentreForHydrology/CRHMr documentation built on April 6, 2024, 5:27 p.m.