get.parameter {componentSkeleton}R Documentation

Get parameter value

Description

Return the value of given parameter or NULL if the parameter name is invalid. The type of returned object depends on the 'type' parameter. If the value of the parameter is not present in the allowd values, error is raised.

Usage

get.parameter(command.file, param.name, type = "string", allowed.values = NULL)

Arguments

command.file

Usually produced by main.

param.name

Parameter name.

type

One of 'string', 'boolean', 'float', 'int'.

allowed.values

Character vector giving the allowed values for the paramter.

Value

Raise an error if type is invalid.

Author(s)

Kristian Ovaska (kristian.ovaska@helsinki.fi)


[Package componentSkeleton version 2.0.1 Index]