ValidateParameterIn: Ensure a parameter is valid

View source: R/Validate.R

ValidateParameterInR Documentation

Ensure a parameter is valid

Description

A valid parameter paramValue is either NULL or in the space of paramPossibilities.

Usage

ValidateParameterIn(paramValue, paramPossibilities, allowNULL = TRUE)

Arguments

paramValue

object. The parameter value to check.

paramPossibilities

vector. A vector of possible values for the parameter.

allowNULL

logical. Whether or not to allow NULL as a possibility.

Value

TRUE if paramValue is valid, otherwise it raises an error.

Examples

## Not run: 
  ValidateParameterIn("all", DataSubset)

## End(Not run)

datarobot documentation built on Nov. 3, 2023, 1:07 a.m.