create_tool

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

internal

Provides an R scripting interface to the open-source 'SAGA-GIS'
(System for Automated Geoscientific Analyses Geographical Information
System) software. 'Rsagacmd' dynamically generates R functions for every
'SAGA-GIS' geoprocessing tool based on the user's currently installed
'SAGA-GIS' version. These functions are contained within an S3 object
and are accessed as a named list of libraries and tools. This structure
facilitates an easier scripting experience by organizing the large number
of 'SAGA-GIS' geoprocessing tools (>700) by their respective library.
Interactive scripting can fully take advantage of code autocompletion tools
(e.g. in 'Rstudio'), allowing for each tools syntax to be quickly
recognized. Furthermore, the most common types of spatial data (via the
'terra', 'sp', and 'sf' packages) along with non-spatial data are
automatically passed from R to the 'SAGA-GIS' command line tool for
geoprocessing operations, and the results are loaded as the appropriate R
object. Outputs from individual 'SAGA-GIS' tools can also be chained using
pipes from the 'magrittr' and 'dplyr' packages to combine complex
geoprocessing operations together in a single statement. 'SAGA-GIS' is
available under a GPLv2 / LGPLv2 licence from
<https://sourceforge.net/projects/saga-gis/> including Windows x86/x64
and macOS binaries. SAGA-GIS is also included in Debian/Ubuntu default software
repositories. Rsagacmd has currently been tested on 'SAGA-GIS' versions
from 2.3.1 to 9.0.1 on Windows, Linux and macOS.

Steven Pawley

Rsagacmd

Linking R with the Open-Source 'SAGA-GIS' Software

create_tool function

<dl><dt>tool_information</dt>
<dd>list</dd>
<dt>tool_options</dt>
<dd>list</dd>
<dt>html_file</dt>
<dd>the name of the html file for the tool's documentation.
Stored to help linking with online documentation.</dd>
<dt>character</dt>
<dd>the description text for the tool that has been scraped from
the help documentation</dd></dl>

Arguments

Generates list of options for a SAGA-GIS tool — create_tool

<dl>

<dt>tool_information</dt>
<dd>list</dd>


<dt>tool_options</dt>
<dd>list</dd>


<dt>html_file</dt>
<dd>the name of the html file for the tool's documentation.
Stored to help linking with online documentation.</dd>


<dt>character</dt>
<dd>the description text for the tool that has been scraped from
the help documentation</dd>

</dl>

create_tool: Generates list of options for a SAGA-GIS tool

Description

Usage

Value

Arguments