checkVectLength: Check length of vector

View source: R/checkVectLength.R

checkVectLengthR Documentation

Check length of vector

Description

checkVectLength checks argument 'x' for expected length 'expeL' and return either message or error when expectation not met. Used for parameter ('sanity') checking in other user front-end functions.

Usage

checkVectLength(
  x,
  expeL = 1,
  stopOnProblem = FALSE,
  silent = FALSE,
  callFrom = NULL
)

Arguments

x

(numeric or charcter vector) input to check length

expeL

(numeric) expected length

stopOnProblem

(logical) continue on problems with message or stop (as error message)

silent

(logical) suppress messages if TRUE

callFrom

(character) allows easier tracking of message(s) produced

Value

NULL (produces only optional message if length is OK or error-message if length is not OK)

Examples

aa <- 1:5; checkVectLength(aa,exp=3)

wrMisc documentation built on Jan. 7, 2023, 1:27 a.m.