propInfo: Get Information about BioLockJ Properties

In BioLockJ-Dev-Team/BioLockR: R Access to the BioLockJ-API

Description

Get Information about BioLockJ Properties

Usage

describeProp(property, module = NULL, externalModules = NULL)

propInfo()

propType(property, module = NULL, externalModules = NULL)

propValue(property, config = NULL, module = NULL, externalModules = NULL)

Arguments

property	the name of a property
module	a BioLockJ module
externalModules	file path to directory with external modules
config	a BioLockJ config file (or properties file) to reference

Value

describeProp: the description of the property as a character string

propInfo: a list of property objects, where each element has named values for "property" (ie name), "type", and "description" and (when applicable) "default".

propType: the type of the property as a character string

propValue: the value of the property (iether the default or the value as specified in config)

Functions

• describeProp:

• propInfo:

• propType:

• propValue:

Examples

describeProp("script.numThreads")
#> "Used to reserve cluster resources and passed to any external application call that accepts a numThreads parameter."

propInfo()

propType("script.numThreads")
#> [1] "integer"

propValue("script.numThreads")
#> "8"

propValue("hardyHarHar") # unrecognized property
#> ""

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