cnd: Create a ParameterSet Condition

In param6: A Fast and Lightweight R6 Parameter Interface

Create a ParameterSet Condition

Description

Function to create a condition for ParameterSet dependencies for use in the $deps public method.

Usage

cnd(type, value = NULL, id = NULL, error = NULL)

Arguments

type	(character(1)) The condition type determines the type of dependency to create, options are given in details.
value	(ANY) If id is NULL then value should be a value in the support of the parameter that the condition is testing, that will be passed to the condition determined by type. Can be left NULL if testing if increasing/decreasing.
id	(character(1)) If value is NULL then id should be the same as the id that the condition is testing, and the condition then takes the currently set value of the id in its argument. Can be left NULL if testing if increasing/decreasing.
error	(character(1)) Optional error message to be displayed on fail.

Details

This function should never be used outside of creating a condition for a dependency in a ParameterSet. Currently the following conditions are supported based on the type argument, we refer to the parameter depended on as in the independent parameter, and the other as the dependent:

• "eq" - If value is not NULL then checks if the independent parameter equals value, otherwise checks if the independent and dependent parameter are equal.

• "neq" - If value is not NULL then checks if the independent parameter does not equal value, otherwise checks if the independent and dependent parameter are not equal.

• "gt"/"lt" - If value is not NULL then checks if the independent parameter is greater/less than value, otherwise checks if the independent parameter is greater/less than the dependent parameter.

• "geq"/"leq" - If value is not NULL then checks if the independent parameter is greater/less than or equal to value, otherwise checks if the independent parameter is greater/less than or equal to the dependent parameter.

• "any" - If value is not NULL then checks if the independent parameter equals any of value, otherwise checks if the independent parameter equals any of dependent parameter.

• "nany" - If value is not NULL then checks if the independent parameter does not equal any of value, otherwise checks if the independent parameter does not equal any of dependent parameter.

• "len" - If value is not NULL then checks if the length of the independent parameter equals value, otherwise checks if the independent and dependent parameter are the same length.

• "inc" - Checks if the parameter is increasing.

• "sinc" - Checks if the parameter is strictly increasing.

• "dec" - Checks if the parameter is decreasing.

• "sdec" - Checks if the parameter is strictly decreasing.

param6 documentation built on March 18, 2022, 6:13 p.m.