print.saga_tool: Generic function to display help and usage information for...
In stevenpawley/RSAGA5: Linking R with the Open-Source 'SAGA-GIS' Software

print.saga_tool

R Documentation

Generic function to display help and usage information for any SAGA-GIS tool

Description

Displays a tibble containing the name of the tool's parameters, the argument name used by Rsagacmd, the identifier used by the SAGA-GIS command line, and additional descriptions, default and options/constraints.

Usage

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

Arguments

`x`	A 'saga_tool' object.
`...`	Additional arguments to pass to print. Currently not used.

Examples

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

# Display usage information on a tool
print(saga$ta_morphometry$slope_aspect_curvature)

# Or simply:
saga$ta_morphometry$slope_aspect_curvature

## End(Not run)

stevenpawley/RSAGA5 documentation built on March 26, 2024, 5:30 a.m.