Rsagacmd0.4.3 package

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

check_output_format

Check the file extension of the output file to see if it is the same a...

convert_sagaext_r

Ensure that the file extension for the SAGA raster format ends with .s...

create_alias

Generates a syntactically-correct R name based on a SAGA-GIS identifie...

create_function

Function generate text that will be parsed into R code

create_tool_overrides

Apply manually-defined changes to specific tools

create_tool

Generates list of options for a SAGA-GIS tool

drop_parameters

Drops unused/empty parameters from a parameters object

extract_tool

Internal function to extract information from a saga_tool object

mrvbf_threshold

Calculate the t_slope value based on DEM resolution for MRVBF

parameter

Parameter class

parameters

Generates a list of parameter objects for a SAGA-GIS tool

parse_options

Convenience function to join together the saga_cmd option:value pairs

print.saga_tool

Generic function to display help and usage information for any SAGA-GI...

read_grid_list

Read a semi-colon separated list of grids that are output by saga_cmd

read_grid

Read a raster data set that is output by saga_cmd

read_output

Primary function to read data sets (raster, vector, tabular) that are ...

read_shapes

Read a spatial vector data set that is output by saga_cmd

read_srtm

Get path to the example DEM data

read_table

Read a tabular data set that is output by saga_cmd

reexports

Objects exported from other packages

Rsagacmd

Rsagacmd: Linking R with the open-source SAGA-GIS software.

run_cmd

Prepares the statement and runs the external saga_cmd executable

saga_configure

Generates a custom saga_cmd configuration file

saga_docs

Browse the online documentation for a saga_tool

saga_env

Parses valid SAGA-GIS libraries and tools into a nested list of functi...

saga_execute

Function to execute SAGA-GIS commands through the command line tool

saga_gis

Initiate a SAGA-GIS geoprocessor object

saga_remove_tmpfiles

Removes temporary files created by Rsagacmd

saga_show_tmpfiles

List temporary files created by Rsagacmd

saga_version

Return the installed version of SAGA-GIS

save_object

Generic methods to save R in-memory objects to file to SAGA-GIS to acc...

search_saga

Automatic search for the path to a SAGA-GIS installation

search_tools

Search for a SAGA-GIS tool

show_raster_formats

List the available raster formats that can be set as defaults for a `s...

show_vector_formats

List the available vector formats that can be set as defaults for a `s...

summarize_tool_params

Interval function used to summarize a saga_tool into a tibble that d...

tidy.saga_library

Summarize the tools that are available within a saga library and retur...

tidy.saga_tool

Summarize the parameters that are available within a SAGA-GIS tool and...

tidy.saga

Summarize the libraries that are available within a saga object and re...

tile_geoprocessor

Split a raster grid into tiles for tile-based processing

update_parameter_file

Updates a parameter object with file paths to the R data objects.

update_parameters_file

Updates a parameters object with file paths to the R data objects.

update_parameters_tempfiles

Update a parameters object using temporary files for any unspecified...

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.5.1 on Windows, Linux and macOS.

  • Maintainer: Steven Pawley
  • License: GPL-3
  • Last published: 2024-09-08