create_tool: Generates list of options for a SAGA-GIS tool
In Rsagacmd: Linking R with the Open-Source 'SAGA-GIS' Software

create_tool

R Documentation

Generates list of options for a SAGA-GIS tool

Description

Parses the html table for a SAGA-GIS tool into a list of identifiers, options, defaults and constraints

Usage

create_tool(tool_information, tool_options, description, html_file)

Arguments

`tool_information`	list
`tool_options`	list
`description`	the description text for the tool that has been scraped from the help documentation
`html_file`	the name of the html file for the tool's documentation. Stored to help linking with online documentation.

Value

A 'saga_tool' object containing: + 'tool_name' A syntactically-correct name for the tool. + ‘description' The tool’s description. + ‘author' The tool’s author. + 'tool_cmd' The command to use for saga_cmd to execute tool. + ‘tool_id' The tool’s ID. + ‘parameters' A named list of the tool’s parameter objects. + 'html_file' The html document name.

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