isRequiresOk: Check if parameter requirements are met.

View source: R/isRequiresOk.R

isRequiresOkR Documentation

Check if parameter requirements are met.

Description

Check if a parameter value satisfies the requirements of the parameter description. This only checks the requires expressions.

Usage

isRequiresOk(par.set, par.vals, ids = names(par.vals), use.defaults = TRUE)

Arguments

par.set

ParamSet
Parameter set.

par.vals

(list())
List of parameter settings.

ids

(character())
ids of the param.vals to check. Default is names(par.vals).

use.defaults

(logical())
Some requirements relay on default values of the par.set. Default is TRUE, which means that if the value is not present in par.vals the default value will be considered.

Value

logical(1)


ParamHelpers documentation built on July 4, 2022, 5:07 p.m.