check_points_and_tvertices.tempnetwork: This function simply combines the function...

Description Usage Arguments Value

View source: R/tempnetwork-inputchecker.R

Description

This function simply combines the function "check_tvertices_exists" and "check_points_exists".

Usage

1
2
3
## S3 method for class 'tempnetwork'
check_points_and_tvertices(tempNetwork,
  pointNameList = NULL, tVertexNameList = NULL, throwError = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

pointNameList

A vector of strings representing the names of points in the 'tempflow'-object of the given 'tempnetwork'-object. If NULL this input will be ignored.

tVertexNameList

A vector of strings representing the names of equivalence-classes in the equivalence-relation of the given 'tempnetwork'-object. If NULL this input will be ignored.

throwError

If TRUE the respective errors will be thrown. Otherwise, a truth value will be returned.

Value

The boolean value TRUE, if the equivalence-classes specified in "tVertexNameList" exist in the equivalence-relation of the given 'tempnetwork'-object.


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