Parameter: Parameter class
In Open-EO/openeo-r-client: Client Interface for 'openEO' Servers
Parameter R Documentation
Parameter class
Description
This class defines parameters of Process. They store information about the type, format and
pattern. A parameter class is designed to not carry any value, as opposed to an
Argument.
Details
The parameters are parsed from the specific description and format of the JSON
objects returned for the parameters in processes. Find a list of openEO-specific formats here:
RFC7946
Value
Object of R6::R6Class() which represents a parameter.
Methods
$new(name, description, required=FALSE)$getNamereturns the name of a parameter as string
$setName(name)sets the name of a parameter
$getDescription()returns the description of a parameter
$setDescription(description)sets the description of a parameter
$getPattern()returns a string with the pattern of a parameter description
$setPattern(pattern)sets the pattern (string) for a parameter
$getDefault()returns the parameter's default value
$setDefault(default)sets the default value of a parameter
$matchesSchema(schema)returns TRUE if the given schema - a list of the parsed openEO
API schema object - matches the parameter's schema, which is used for finding the corresponding parameter
$getSchema()returns the schema definition
$asParameterInfo()returns a list representation of this parameter for being sent in a JSON to the openEO service
$isNullable()returns TRUE if the parameter is allowed to be nullable, FALSE otherwise
$isRequired()returns whether a parameter is mandatory or not
$isAny()returns TRUE if this parameter describes a choice of parameters
Arguments
namecharacter - The name of a parameter
descriptioncharacter - The description of a parameter
requiredlogical - whether it is required or not
patternthe regexp as a string indicating how to formulate the value
defaultthe regexp as a string indicating how to formulate the value
schemathe parsed schema object of a process parameter as a list
Open-EO/openeo-r-client documentation built on Jan. 26, 2025, 9:28 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Parameter | R Documentation |
Parameter class
Description
This class defines parameters of Process. They store information about the type, format and pattern. A parameter class is designed to not carry any value, as opposed to an Argument.
Details
The parameters are parsed from the specific description and format of the JSON objects returned for the parameters in processes. Find a list of openEO-specific formats here: RFC7946
Value
Object of R6::R6Class() which represents a parameter.
Methods
$new(name, description, required=FALSE)$getNamereturns the name of a parameter as string
$setName(name)sets the name of a parameter
$getDescription()returns the description of a parameter
$setDescription(description)sets the description of a parameter
$getPattern()returns a string with the pattern of a parameter description
$setPattern(pattern)sets the pattern (string) for a parameter
$getDefault()returns the parameter's default value
$setDefault(default)sets the default value of a parameter
$matchesSchema(schema)returns TRUE if the given schema - a list of the parsed openEO API schema object - matches the parameter's schema, which is used for finding the corresponding parameter
$getSchema()returns the schema definition
$asParameterInfo()returns a list representation of this parameter for being sent in a JSON to the openEO service
$isNullable()returns TRUE if the parameter is allowed to be nullable, FALSE otherwise
$isRequired()returns whether a parameter is mandatory or not
$isAny()returns TRUE if this parameter describes a choice of parameters
Arguments
namecharacter - The name of a parameter
descriptioncharacter - The description of a parameter
requiredlogical - whether it is required or not
patternthe regexp as a string indicating how to formulate the value
defaultthe regexp as a string indicating how to formulate the value
schemathe parsed schema object of a process parameter as a list
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.