tidy.saga_tool: Summarize the parameters that are available within a SAGA-GIS...

View source: R/tidy.R

tidy.saga_toolR Documentation

Summarize the parameters that are available within a SAGA-GIS tool and return these as a tibble.

Description

Summarize the parameters that are available within a SAGA-GIS tool and return these as a tibble.

Usage

## S3 method for class 'saga_tool'
tidy(x, ...)

Arguments

x

a 'saga_tool' object

...

additional arguments. Currently unused.

Value

a tibble that describes tools, identifiers used by the saga_cmd command line tool, the equivalent argument name used by Rsagacmd, and other options and descriptions.

Examples

## Not run: 
# Initialize a saga object
saga <- saga_gis()

# tidy the tools parameters into a tibble
tidy(saga$ta_morphometry$slope_aspect_curvature)

## End(Not run)

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