saga_env

An optional character vector to specify the path to the
saga_cmd executable. Otherwise the function will perform a search for
saga_cmd.

saga_bin

A character vector of a subset of SAGA-GIS tool libraries to
generate dynamic functions that map to each tool. Used to save time if you
only want to import a single library.

opt_lib

Establishes the link to SAGA GIS by generating a SAGA help file and parsing
all libraries, tools and options from the help files into a nested list of
library, module and options, that are contained within an saga environment
object object. Intended to be used internally by <code><a rd-options="" href="/link/saga_gis?package=Rsagacmd&version=0.0.9" data-mini-rdoc="Rsagacmd::saga_gis">saga_gis</a></code>

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 'raster', '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/x84 binaries. SAGA-GIS is also included in Debian/Ubuntu default software repositories and is available for macOS using homebrew (<https://brew.sh/>) from the osgeo/osgeo4mac (<https://github.com/OSGeo/homebrew-osgeo4mac>) formula tap. Rsagacmd has currently been tested on 'SAGA-GIS' versions from 2.3.1 to 7.6.0 on Windows, Linux and macOS.

Steven Pawley

Rsagacmd

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

saga_env function

Establishes the link to SAGA GIS by generating a SAGA help file and parsing
all libraries, tools and options from the help files into a nested list of
library, module and options, that are contained within an saga environment
object object. Intended to be used internally by <code><a rd-options='' href='saga_gis'>saga_gis</a></code>

saga_env: Parses valid SAGA-GIS libraries and tools into a nested list of functions

Description

Usage

Arguments

Value