parameter: Parameter class

View source: R/parameters.R

parameterR Documentation

Parameter class

Description

Stores metadata associated with each SAGA-GIS tool parameter.

Usage

parameter(type, name, alias, identifier, description, constraints)

Arguments

type

A character to describe the data type of the parameter. One of "input", "output", "Grid", "Grid list", "Shapes", "Shapes list", "Table", "Static table", "Table list", "File path", "field", "Integer", "Choice", "Floating point", "Boolean", "Long text", "Text.

name

A character with the long name of the parameter.

alias

A syntactically correct alias for the identifier.

identifier

A character with the identifier of the parameter used by saga_cmd.

description

A character with the description of the parameter.

constraints

A character describing the parameters constraints.

Value

A 'parameter' class object.


Rsagacmd documentation built on Oct. 16, 2023, 5:06 p.m.