isValidProp: Is this property value valid ?

Description Usage Arguments Details Value Examples

View source: R/isValidProp.R

Description

Check individual BioLockJ property-value key pair for correct format.

Usage

1
isValidProp(property, value, module = NULL, externalModules = NULL)

Arguments

property

the name of a property

value

the value for property

module

a BioLockJ module

externalModules

file path to directory with external modules

Details

IF a module is supplied, then additionally call the validateProp(key, value) for that module, or for EACH module if a comma-separated list is given.

Value

boolean T/F/NA. Returns true if the value for the property is valid; false if property is a known property but value is not a valid value for it, and NA if property is not a recognized property.

Examples

1
2
3
4
5
6
isValidProp("script.numThreads", 8)
#> TRUE
isValidProp("script.numThreads", "apple")
#> FALSE
isValidProp("hardy", "har")
#> NA

BioLockJ-Dev-Team/BioLockR documentation built on March 9, 2021, 10:43 p.m.