set_point_names.tempflow: Given a vector containing the current point-names (or...

In KonstantinRK/tempnetwork:

Description

Given a vector containing the current point-names (or point-ids) and a vector containing strings, this function changes the names of the specified points to the strings in the 'nameList'-vector.

Usage

## S3 method for class 'tempflow'
set_point_names(tempFlow, pointList = tP(tempFlow),
  nameList = NULL, safe = TRUE)

Arguments

tempFlow	A 'tempflow'-object.
pointList	A vector containing the point-names (or point-ids) of the points which names ought to be changed.
nameList	A vector containing strings that ought to become the new names of the specified points.
safe	If TRUE, it will be ensured that the specified point-names (or point-ids) are present in the given 'tempflow'-object; the 'pointList'-vector and 'nameList'-vector are of the same length; that point-names remain unique; that point-names remain strings.

Value

A 'tempflow'-object, where the point-names of the points specified in the 'pointList'-vector are assigned the names given by the 'nameList'-vector.

KonstantinRK/tempnetwork documentation built on Dec. 23, 2019, 6:40 p.m.