diff --git a/README.md b/README.md index acf989b..7d38259 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,10 @@ by: ``` r library(Rsagacmd) library(terra) -#> terra 1.7.55 +#> terra 1.7.78 +``` + +``` r # initiate a saga object saga <- saga_gis(raster_backend = "terra") @@ -101,6 +104,9 @@ saga <- saga_gis(raster_backend = "terra") #> /Applications/SAGA.app/Contents/MacOS/saga_cmd #> /Applications/QGIS.app/Contents/MacOS/bin/saga_cmd #> Choosing newest version. Manually specify the location when calling saga_gis() to use an older version +``` + +``` r # load the example data srtm <- read_srtm() @@ -112,8 +118,8 @@ saga$ta_morphometry$mass_balance_index(dem = srtm) #> resolution : 100, 100 (x, y) #> extent : 310009.9, 350009.9, 5879989, 5919989 (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83(CSRS) / Alberta 10-TM (Forest) (EPSG:3402) -#> source : file19ef60012a7.sdat -#> name : file19ef60012a7 +#> source : file4eb14c1fed6d.sdat +#> name : file4eb14c1fed6d ``` This facilitates an easier scripting experience by organizing the large @@ -207,6 +213,9 @@ processing steps with pipes: ``` r library(sf) #> Linking to GEOS 3.11.0, GDAL 3.5.3, PROJ 9.1.0; sf_use_s2() is TRUE +``` + +``` r # read project area as a simple features object prj_bnd <- st_polygon(list(matrix( @@ -245,23 +254,23 @@ files can be cleaned during the session using: ``` r saga_remove_tmpfiles(h = 0) #> Removing Rsagacmd temporary files h=0 -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef60012a7.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef61f3a27a.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef2ec55176.gpkg -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef1c6731f7.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef561275bc.sdat -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef55efb5c9.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef6c87cb32.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef472d7748.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef79f23c79.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19efe606a7b.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef5beeb89c.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef159a38eb.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef400ed761.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19efe5e4222.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef4e47cd8c.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef4c07ca7a.sgrd -#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpJHVnhB/file19ef137e3695.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb14c1fed6d.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb12558974c.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb12024c75.gpkg +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb164e9965a.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb1614976ca.sdat +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb134ba9aa2.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb146fe1cb9.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb1550fda18.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb13b78949.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb16961987.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb16865f171.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb17cce6742.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb152dd5e11.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb1434ad897.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb166d1c404.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb1559c1758.sgrd +#> /var/folders/_m/kbp8r1612yj1xl6ndb2y8vpm0000gn/T//RtmpN0uS0X/file4eb17ac0be50.sgrd ``` where `h` is minimum age (in number of hours) of tempfiles for removal, diff --git a/docs/404.html b/docs/404.html index 9626b2c..22ecc80 100644 --- a/docs/404.html +++ b/docs/404.html @@ -6,7 +6,7 @@ Page not found (404) • Rsagacmd - + @@ -18,7 +18,7 @@ - +
- +
@@ -88,16 +88,16 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 4b73574..1cb3534 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,9 +1,9 @@ -License • RsagacmdLicense • Rsagacmd - +
- +
@@ -737,15 +737,15 @@

License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/authors.html b/docs/authors.html index f3007cf..ac21e16 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,9 +1,9 @@ -Authors and Citation • RsagacmdAuthors and Citation • Rsagacmd - +
- +
-

Authors

+

Authors and Citation

- +
  • -

    Steven Pawley. Author, maintainer. +

    Steven Pawley. Author, maintainer.

@@ -61,14 +61,14 @@

Citation

-

Pawley S (2023). +

Pawley S (2024). Rsagacmd: Linking R with the Open-Source 'SAGA-GIS' Software. -R package version 0.4.2, https://stevenpawley.github.io/Rsagacmd/. +R package version 0.4.2, https://stevenpawley.github.io/Rsagacmd/. 

@Manual{,
   title = {Rsagacmd: Linking R with the Open-Source 'SAGA-GIS' Software},
   author = {Steven Pawley},
-  year = {2023},
+  year = {2024},
   note = {R package version 0.4.2},
   url = {https://stevenpawley.github.io/Rsagacmd/},
 }
@@ -84,15 +84,15 @@

Citation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/index.html b/docs/index.html index 1e98bf3..abf7df0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,41 +6,20 @@ Linking R with the Open-Source SAGA-GIS Software • Rsagacmd - + - + - +
- +
@@ -202,7 +181,7 @@

Combining SAGA-GIS tools with pipes # Terrain ruggedness index and automatically save the result to a tempfile tri <- saga$ta_morphometry$terrain_ruggedness_index_tri(dem = dem, radius = 3) -plot(tri)

+plot(tri)

This example will write the output terrain ruggedness index to a temporary file, and will automatically load the result into the R environment as a SpatRaster object. This was implemented for convenience, and so that the user can also create complex workflows that require very little code. It is also means that you can combine several processing steps with pipes:

@@ -227,10 +206,10 @@ 
Combining SAGA-GIS tools with pipes
 # clip dem to shape, resample, and calculate land surface parameters
 lsps <- dem %>%
   saga$shapes_grid$clip_grid_with_rectangle(shapes = prj_bnd) %>%
-  aggregate(fact = 2, fun = "mean") %>%
+  aggregate(fact = 2, fun = "mean") %>%
   saga$ta_morphometry$slope_aspect_curvature()
 
-plot(lsps$slope)
+plot(lsps$slope)

In the above example, three tools are joined together using pipes, and only the land surface parameter grids are returned as SpatRaster objects. The intermediate processing steps are dealt with automatically by saving the outputs as tempfiles. When dealing with high-resolution and/or larger raster data, these tempfiles can start to consume a significant amount of disk space over a session. If required, temporary files can be cleaned during the session using:

@@ -320,16 +299,16 @@ 
Dev status

 
 

   

-
Site built with pkgdown 2.0.7.

+
Site built with pkgdown 2.1.0.
- - + + diff --git a/docs/news/index.html b/docs/news/index.html index ab60bda..59436eb 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -1,9 +1,9 @@ -Changelog • RsagacmdChangelog • Rsagacmd - +
- +
@@ -110,15 +110,15 @@

Rsagacmd 0.1.0
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index a485624..9eb9201 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,6 +1,5 @@ -pandoc: 3.1.1 -pkgdown: 2.0.7 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: {} -last_built: 2023-10-15T16:18Z - +last_built: 2024-07-18T17:24Z diff --git a/docs/reference/Rsagacmd.html b/docs/reference/Rsagacmd.html index 4cd8de1..3f876a1 100644 --- a/docs/reference/Rsagacmd.html +++ b/docs/reference/Rsagacmd.html @@ -1,8 +1,8 @@ -Rsagacmd: Linking R with the open-source SAGA-GIS software. — Rsagacmd • RsagacmdRsagacmd: Linking R with the open-source SAGA-GIS software. — Rsagacmd • Rsagacmd - +
@@ -51,20 +51,20 @@
- +

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

- Source: R/Rsagacmd.R + Source: R/Rsagacmd-package.R
@@ -72,7 +72,7 @@

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

Rsagacmd provides an R scripting interface to the open-source System for Automated Geoscientific Analyses Geographical Information System software SAGA-GIS. The current -version has been tested using SAGA-GIS versions 2.3.1 to 8.0.1 on Windows +version has been tested using SAGA-GIS versions 2.3.1 to 9.2 on Windows (x64), macOS and Linux. Rsagacmd provides a functional approach to scripting with SAGA-GIS by dynamically generating R functions for every SAGA-GIS tool based on the user's current SAGA-GIS installation. These functions are @@ -81,7 +81,7 @@

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

an easier scripting experience by organizing the large number of SAGA-GIS tools (>700) by their respective library. Interactive scripting can also fully take advantage of code autocompletion tools (e.g. in -Rstudio), allowing for each tool's syntax to +Rstudio), allowing for each tool's syntax to be quickly recognized. Furthermore, the most common types of spatial data (rasters using the terra and stars packages, and vector data using sp, sf or terra packages) along with non-spatial data @@ -143,15 +143,21 @@

Combining SAGA-GIS tools with pipes

consume a significant amount of disk space during a session. If required, these temporary files can be cleaned during the session using the saga_remove_tmpfiles function.

+
+

Author

-

Steven Pawley, dr.stevenpawley@gmail.com

+

Maintainer: Steven Pawley dr.stevenpawley@gmail.com

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(Rsagacmd)
 library(magrittr)
 
@@ -168,8 +174,7 @@ 
Examples

 
 # Remove tempfiles generated by Rsagacmd during a session
 saga_remove_tmpfiles(h = 0)
-}
-
+} # }
@@ -184,15 +189,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/check_output_format.html b/docs/reference/check_output_format.html index e0256e0..8bd3f12 100644 --- a/docs/reference/check_output_format.html +++ b/docs/reference/check_output_format.html @@ -1,13 +1,5 @@ -Check the file extension of the output file to see if it is the same as the -`raster_format` or `vector_format` settings. If a raster, such as a GeoTIFF -is output directly from a SAGA-GIS tool but the raster format is set to SAGA, -then this might work depending on the saga version but Rsagacmd will not -know how to read the file. — check_output_format • RsagacmdCheck the file extension of the output file to see if it is the same as the `raster_format` or `vector_format` settings. If a raster, such as a GeoTIFF is output directly from a SAGA-GIS tool but the raster format is set to SAGA, then this might work depending on the saga version but Rsagacmd will not know how to read the file. — check_output_format • Rsagacmd - +
- +
-

Check the file extension of the output file to see if it is the same as the -`raster_format` or `vector_format` settings. If a raster, such as a GeoTIFF -is output directly from a SAGA-GIS tool but the raster format is set to SAGA, -then this might work depending on the saga version but Rsagacmd will not -know how to read the file.

+

Check the file extension of the output file to see if it is the same as the `raster_format` or `vector_format` settings. If a raster, such as a GeoTIFF is output directly from a SAGA-GIS tool but the raster format is set to SAGA, then this might work depending on the saga version but Rsagacmd will not know how to read the file.

Source: R/file-extensions.R
@@ -78,15 +66,17 @@

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

Arguments

-
x
+ + +
x

a `parameter` object that is an output parameter of a tool.

-
raster_format
+
raster_format

the raster format.

-
vector_format
+
vector_format

the vector format.

@@ -103,15 +93,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/convert_sagaext_r.html b/docs/reference/convert_sagaext_r.html index f809698..52eaa2a 100644 --- a/docs/reference/convert_sagaext_r.html +++ b/docs/reference/convert_sagaext_r.html @@ -1,12 +1,10 @@ -Ensure that the file extension for the SAGA raster format ends with .sdat for -reading or writing SAGA grid objects in R. — convert_sagaext_r • RsagacmdEnsure that the file extension for the SAGA raster format ends with .sdat for reading or writing SAGA grid objects in R. — convert_sagaext_r • Rsagacmd - +
- +
-

Ensure that the file extension for the SAGA raster format ends with .sdat for -reading or writing SAGA grid objects in R.

+

Ensure that the file extension for the SAGA raster format ends with .sdat for reading or writing SAGA grid objects in R.

Source: R/file-extensions.R
@@ -63,15 +60,15 @@

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

Arguments

-
fp
+ + +
fp

file path to raster writing

Value

- - -

a character vector with the corrected file extensions to read SAGA +

a character vector with the corrected file extensions to read SAGA sgrd files back into R.

@@ -87,15 +84,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/create_alias.html b/docs/reference/create_alias.html index b6e044d..558342d 100644 --- a/docs/reference/create_alias.html +++ b/docs/reference/create_alias.html @@ -1,12 +1,12 @@ -Generates a syntactically-correct R name based on a SAGA-GIS identifier — create_alias • RsagacmdGenerates a syntactically-correct R name based on a SAGA-GIS identifier — create_alias • Rsagacmd - +
- +
@@ -64,15 +64,15 @@

Generates a syntactically-correct R name based on a SAGA-GIS identifier

Arguments

-
identifier
+ + +
identifier

A character with the identifier.

Value

- - -

A character with a syntactically-correct alias.

+

A character with a syntactically-correct alias.

@@ -87,15 +87,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/create_function.html b/docs/reference/create_function.html index e409f24..106e01f 100644 --- a/docs/reference/create_function.html +++ b/docs/reference/create_function.html @@ -1,12 +1,12 @@ -Function generate text that will be parsed into R code — create_function • RsagacmdFunction generate text that will be parsed into R code — create_function • Rsagacmd - +
- +
@@ -64,19 +64,19 @@

Function generate text that will be parsed into R code

Arguments

-
lib
+ + +
lib

A character, name of SAGA-GIS library.

-
tool
+
tool

A character, name of SAGA-GIS tool.

Value

- - -

A character, text that is to be parsed into a function definition.

+

A character, text that is to be parsed into a function definition.

@@ -91,15 +91,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/create_tool.html b/docs/reference/create_tool.html index 3138215..9b7143a 100644 --- a/docs/reference/create_tool.html +++ b/docs/reference/create_tool.html @@ -1,10 +1,10 @@ -Generates list of options for a SAGA-GIS tool — create_tool • RsagacmdGenerates list of options for a SAGA-GIS tool — create_tool • Rsagacmd - +
- +
@@ -60,33 +60,34 @@

Generates list of options for a SAGA-GIS tool

Arguments

-
tool_information
+ + +
tool_information

list

-
tool_options
+
tool_options

list

-
html_file
-

the name of the html file for the tool's documentation. -Stored to help linking with online documentation.

+
description
+

the description text for the tool that has been scraped +from the help documentation

-
character
-

the description text for the tool that has been scraped from -the help documentation

+
html_file
+

the name of the html file for the tool's documentation. +Stored to help linking with online documentation.

Value

- - -

A `saga_tool` object containing: +

A `saga_tool` object containing: + `tool_name` A syntactically-correct name for the tool. + `description` The tool's description. + `author` The tool's author. + `tool_cmd` The command to use for saga_cmd to execute tool. ++ `tool_id` The tool's ID. + `parameters` A named list of the tool's parameter objects. + `html_file` The html document name.

@@ -103,15 +104,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/create_tool_overrides.html b/docs/reference/create_tool_overrides.html index 8c6f252..429e5bb 100644 --- a/docs/reference/create_tool_overrides.html +++ b/docs/reference/create_tool_overrides.html @@ -1,10 +1,10 @@ -Apply manually-defined changes to specific tools — create_tool_overrides • RsagacmdApply manually-defined changes to specific tools — create_tool_overrides • Rsagacmd - +
- +
@@ -51,7 +51,7 @@

Apply manually-defined changes to specific tools

Used to manually alter or add parameters for specific tools outside of what -has been defined based on the output of saga_cmd --create-docs

+has been defined based on the output of saga_cmd –create-docs

@@ -60,20 +60,20 @@

Apply manually-defined changes to specific tools

Arguments

-
tool_name
+ + +
tool_name

character, name of the tool. This is the alias name used by Rsagacmd, i.e. the tool name without spaces, all lowercase etc.

-
params
+
params

the `parameters` object for the tool

Value

- - -

the altered `parameters` object

+

the altered `parameters` object

@@ -88,15 +88,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/drop_parameters.html b/docs/reference/drop_parameters.html index bd098cf..e4f6cff 100644 --- a/docs/reference/drop_parameters.html +++ b/docs/reference/drop_parameters.html @@ -1,9 +1,9 @@ -Drops unused/empty parameters from a `parameters` object — drop_parameters • RsagacmdDrops unused/empty parameters from a `parameters` object — drop_parameters • Rsagacmd - +
- +
@@ -58,15 +58,15 @@

Drops unused/empty parameters from a `parameters` object

Arguments

-
params
+ + +
params

A `parameters` object

Value

- - -

A `parameters` object with empty `parameter` objects removed

+

A `parameters` object with empty `parameter` objects removed

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/extract_tool.html b/docs/reference/extract_tool.html index ffcee39..7070d0e 100644 --- a/docs/reference/extract_tool.html +++ b/docs/reference/extract_tool.html @@ -1,9 +1,9 @@ -Internal function to extract information from a `saga_tool` object — extract_tool • RsagacmdInternal function to extract information from a `saga_tool` object — extract_tool • Rsagacmd - +
- +
@@ -58,15 +58,15 @@

Internal function to extract information from a `saga_tool` object

Arguments

-
x
+ + +
x

a `saga_tool` object

Value

- - -

the intervals of a `saga_tool`

+

the intervals of a `saga_tool`

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 3220023..701d952 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,9 +1,9 @@ -Function reference • RsagacmdPackage index • Rsagacmd - +
- +
@@ -51,10 +51,6 @@

All functions

-

Rsagacmd_usage

- -

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

-

mrvbf_threshold()

Calculate the t_slope value based on DEM resolution for MRVBF

@@ -109,28 +105,23 @@

All functions

show_raster_formats()

-

List the available raster formats that can be set as defaults for a `saga` -object.

+

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

show_vector_formats()

-

List the available vector formats that can be set as defaults for a `saga` -object.

+

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

tidy(<saga>)

-

Summarize the libraries that are available within a saga object and -return these as a tibble.

+

Summarize the libraries that are available within a saga object and return these as a tibble.

tidy(<saga_library>)

-

Summarize the tools that are available within a saga library and -return these as a tibble.

+

Summarize the tools that are available within a saga library and return these as a tibble.

tidy(<saga_tool>)

-

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

+

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

tile_geoprocessor()

@@ -148,15 +139,15 @@

All functions
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/mrvbf_threshold.html b/docs/reference/mrvbf_threshold.html index 7fd23f0..ffd76f3 100644 --- a/docs/reference/mrvbf_threshold.html +++ b/docs/reference/mrvbf_threshold.html @@ -1,5 +1,5 @@ -Calculate the t_slope value based on DEM resolution for MRVBF — mrvbf_threshold • RsagacmdCalculate the t_slope value based on DEM resolution for MRVBF — mrvbf_threshold • Rsagacmd - +
- +
@@ -74,15 +74,15 @@

Calculate the t_slope value based on DEM resolution for MRVBF

Arguments

-
res
+ + +
res

numeric, DEM resolution

Value

- - -

numeric, t_slope value for MRVBF

+

numeric, t_slope value for MRVBF

@@ -103,15 +103,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/parameter.html b/docs/reference/parameter.html index ba04fd5..6451f6f 100644 --- a/docs/reference/parameter.html +++ b/docs/reference/parameter.html @@ -1,9 +1,9 @@ -Parameter class — parameter • RsagacmdParameter class — parameter • Rsagacmd - +
- +
@@ -58,39 +58,39 @@

Parameter class

Arguments

-
type
+ + +
type

A character to describe the data type of the parameter. One of "input", "output", "Grid", "Grid list", "Shapes", "Shapes list", "Table", "Static table", "Table list", "File path", "field", "Integer", "Choice", "Floating point", "Boolean", "Long text", "Text.

-
name
+
name

A character with the long name of the parameter.

-
alias
+
alias

A syntactically correct alias for the identifier.

-
identifier
+
identifier

A character with the identifier of the parameter used by saga_cmd.

-
description
+
description

A character with the description of the parameter.

-
constraints
+
constraints

A character describing the parameters constraints.

Value

- - -

A `parameter` class object.

+

A `parameter` class object.

@@ -105,15 +105,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/parameters.html b/docs/reference/parameters.html index 162ae56..f8ceb8e 100644 --- a/docs/reference/parameters.html +++ b/docs/reference/parameters.html @@ -1,11 +1,11 @@ -Generates a list of `parameter` objects for a SAGA-GIS tool — parameters • RsagacmdGenerates a list of `parameter` objects for a SAGA-GIS tool — parameters • Rsagacmd - +
- +
@@ -62,16 +62,16 @@

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

Arguments

-
tool_options
+ + +
tool_options

A data.frame containing the table that refers to the SAGA-GIS tool parameter options.

Value

- - -

A `parameters` object

+

A `parameters` object

@@ -86,15 +86,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/parse_options.html b/docs/reference/parse_options.html index 90e0d72..3dc8a9c 100644 --- a/docs/reference/parse_options.html +++ b/docs/reference/parse_options.html @@ -1,9 +1,9 @@ -Convenience function to join together the saga_cmd option:value pairs — parse_options • RsagacmdConvenience function to join together the saga_cmd option:value pairs — parse_options • Rsagacmd - +
- +
@@ -58,19 +58,19 @@

Convenience function to join together the saga_cmd option:value pairs

Arguments

-
key
+ + +
key

character, the saga_cmd option such as "DEM".

-
value
+
value

character, the value of the option.

Value

- - -

character, a joined option:value pair such as "-DEM:mygrid.tif"

+

character, a joined option:value pair such as "-DEM:mygrid.tif"

@@ -85,15 +85,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/print.saga_tool.html b/docs/reference/print.saga_tool.html index 1b1ae83..892b06c 100644 --- a/docs/reference/print.saga_tool.html +++ b/docs/reference/print.saga_tool.html @@ -1,11 +1,11 @@ -Generic function to display help and usage information for any SAGA-GIS tool — print.saga_tool • RsagacmdGeneric function to display help and usage information for any SAGA-GIS tool — print.saga_tool • Rsagacmd - +
- +
@@ -57,24 +57,26 @@

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

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

Arguments

-
x
+ + +
x

A `saga_tool` object.

-
...
+
...

Additional arguments to pass to print. Currently not used.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Initialize a saga object
 saga <- saga_gis()
 
@@ -83,7 +85,7 @@ 
Examples

 
 # Or simply:
 saga$ta_morphometry$slope_aspect_curvature
-}
+} # }
@@ -98,15 +100,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/read_grid.html b/docs/reference/read_grid.html index 599e7d3..21fd540 100644 --- a/docs/reference/read_grid.html +++ b/docs/reference/read_grid.html @@ -1,9 +1,9 @@ -Read a raster data set that is output by saga_cmd — read_grid • RsagacmdRead a raster data set that is output by saga_cmd — read_grid • Rsagacmd - +
- +
@@ -58,21 +58,21 @@

Read a raster data set that is output by saga_cmd

Arguments

-
x
+ + +
x

list, a `options` object that was created by the `create_tool` function that contains the parameters for a particular tool and its outputs.

-
backend
+
backend

character, either "raster", "terra" or "stars".

Value

- - -

either a `raster` or `SpatRaster` object

+

either a `raster` or `SpatRaster` object

@@ -87,15 +87,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/read_grid_list.html b/docs/reference/read_grid_list.html index bfc39e6..ed26ac7 100644 --- a/docs/reference/read_grid_list.html +++ b/docs/reference/read_grid_list.html @@ -1,9 +1,9 @@ -Read a semi-colon separated list of grids that are output by saga_cmd — read_grid_list • RsagacmdRead a semi-colon separated list of grids that are output by saga_cmd — read_grid_list • Rsagacmd - +
- +
@@ -58,21 +58,21 @@

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

Arguments

-
x
+ + +
x

list, a `options` object that was created by the `create_tool` function that contains the parameters for a particular tool and its outputs.

-
backend
+
backend

character, either "raster" or "terra"

Value

- - -

list, containing multiple `raster` or `SpatRaster` objects.

+

list, containing multiple `raster` or `SpatRaster` objects.

@@ -87,15 +87,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/read_output.html b/docs/reference/read_output.html index 5f14342..0e3ce42 100644 --- a/docs/reference/read_output.html +++ b/docs/reference/read_output.html @@ -1,12 +1,10 @@ -Primary function to read data sets (raster, vector, tabular) that are output -by saga_cmd — read_output • RsagacmdPrimary function to read data sets (raster, vector, tabular) that are output by saga_cmd — read_output • Rsagacmd - +
- +
-

Primary function to read data sets (raster, vector, tabular) that are output -by saga_cmd

+

Primary function to read data sets (raster, vector, tabular) that are output by saga_cmd

Source: R/io-read.R
@@ -63,30 +60,30 @@

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

Arguments

-
output
+ + +
output

list, a `options` object that was created by the `create_tool` function that contains the parameters for a particular tool and its outputs.

-
raster_backend
+
raster_backend

character, either "raster" or "terra"

-
vector_backend
+
vector_backend

character, either "sf", "SpatVector" or "SpatVectorProxy"

-
.intern
+
.intern

logical, whether to load the output as an R object

Value

- - -

the loaded objects, or NULL is `.intern = FALSE`.

+

the loaded objects, or NULL is `.intern = FALSE`.

@@ -101,15 +98,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/read_shapes.html b/docs/reference/read_shapes.html index 2d07135..544cb82 100644 --- a/docs/reference/read_shapes.html +++ b/docs/reference/read_shapes.html @@ -1,9 +1,9 @@ -Read a spatial vector data set that is output by saga_cmd — read_shapes • RsagacmdRead a spatial vector data set that is output by saga_cmd — read_shapes • Rsagacmd - +
- +
@@ -58,21 +58,21 @@

Read a spatial vector data set that is output by saga_cmd

Arguments

-
x
+ + +
x

list, a `options` object that was created by the `create_tool` function that contains the parameters for a particular tool and its outputs.

-
vector_backend
+
vector_backend

character for vector backend to use.

Value

- - -

an `sf` object.

+

an `sf` object.

@@ -87,15 +87,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/read_srtm-1.png b/docs/reference/read_srtm-1.png index 84a63b1..a3d627d 100644 Binary files a/docs/reference/read_srtm-1.png and b/docs/reference/read_srtm-1.png differ diff --git a/docs/reference/read_srtm.html b/docs/reference/read_srtm.html index 4cdee2e..78cab1c 100644 --- a/docs/reference/read_srtm.html +++ b/docs/reference/read_srtm.html @@ -1,11 +1,11 @@ -Get path to the example DEM data — read_srtm • RsagacmdGet path to the example DEM data — read_srtm • Rsagacmd - +
- +
@@ -73,10 +73,10 @@

Details

Examples

library(Rsagacmd)
 library(terra)
-#> terra 1.7.55
+#> terra 1.7.78
 
 dem <- read_srtm()
-plot(dem)
+plot(dem)
@@ -92,15 +92,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/read_table.html b/docs/reference/read_table.html index 964a3bb..6dbe3b5 100644 --- a/docs/reference/read_table.html +++ b/docs/reference/read_table.html @@ -1,9 +1,9 @@ -Read a tabular data set that is output by saga_cmd — read_table • RsagacmdRead a tabular data set that is output by saga_cmd — read_table • Rsagacmd - +
- +
@@ -58,7 +58,9 @@

Read a tabular data set that is output by saga_cmd

Arguments

-
x
+ + +
x

list, a `options` object that was created by the `create_tool` function that contains the parameters for a particular tool and its outputs.

@@ -66,9 +68,7 @@

Arguments

Value

- - -

a `tibble`.

+

a `tibble`.

@@ -83,15 +83,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/reexports.html b/docs/reference/reexports.html index ca68520..581367d 100644 --- a/docs/reference/reexports.html +++ b/docs/reference/reexports.html @@ -1,5 +1,5 @@ -Objects exported from other packages — reexports • RsagacmdObjects exported from other packages — reexports • Rsagacmd - +
- +
@@ -78,15 +78,15 @@

Objects exported from other packages

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/run_cmd.html b/docs/reference/run_cmd.html index fa97815..68aeec9 100644 --- a/docs/reference/run_cmd.html +++ b/docs/reference/run_cmd.html @@ -1,9 +1,9 @@ -Prepares the statement and runs the external saga_cmd executable — run_cmd • RsagacmdPrepares the statement and runs the external saga_cmd executable — run_cmd • Rsagacmd - +
- +
@@ -58,37 +58,37 @@

Prepares the statement and runs the external saga_cmd executable

Arguments

-
saga_cmd
+ + +
saga_cmd

character, name of the saga_cmd executable or alias.

-
saga_config
+
saga_config

character, path to the saga configuration "ini" file.

-
lib
+
lib

character, name of the selected library.

-
tool_cmd
+
tool_cmd

character, name of the selected tool.

-
args
+
args

named list of tool options, such as list(DEM = "mygrid.tif", RADIUS = 3).

-
verbose
+
verbose

logical, whether to show all saga_cmd messages on the R console.

Value

- - -

list, output from `processx::run()`

+

list, output from `processx::run()`

@@ -103,15 +103,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_configure.html b/docs/reference/saga_configure.html index cde1192..0cbbb36 100644 --- a/docs/reference/saga_configure.html +++ b/docs/reference/saga_configure.html @@ -1,11 +1,11 @@ -Generates a custom saga_cmd configuration file — saga_configure • RsagacmdGenerates a custom saga_cmd configuration file — saga_configure • Rsagacmd - +
- +
@@ -69,32 +69,34 @@

Generates a custom saga_cmd configuration file

Arguments

-
senv
+ + +
senv

A saga environment object. Contains the SAGA-GIS environment and settings.

-
grid_caching
+
grid_caching

Whether to use file caching. The default is FALSE.

-
grid_cache_threshold
+
grid_cache_threshold

Any number to use as a threshold (in Mb) before file caching for loaded raster data is activated.

-
grid_cache_dir
+
grid_cache_dir

Optionally specify a path to the used directory for temporary files. The default uses `base::tempdir`.

-
cores
+
cores

An integer specifying the maximum number of processing cores. Needs to be set to 1 if file caching is activated because file caching in SAGA-GIS is not thread-safe.

-
saga_vers
+
saga_vers

A `numeric_version` that specifies the version of SAGA-GIS. The generation of a saga_cmd configuration file is only valid for versions > 4.0.0.

@@ -102,9 +104,7 @@

Arguments

Value

- - -

A character that specifies the path to custom saga_cmd initiation +

A character that specifies the path to custom saga_cmd initiation file.

@@ -120,15 +120,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_docs.html b/docs/reference/saga_docs.html index 31dbecc..654f26a 100644 --- a/docs/reference/saga_docs.html +++ b/docs/reference/saga_docs.html @@ -1,9 +1,9 @@ -Browse the online documentation for a saga_tool — saga_docs • RsagacmdBrowse the online documentation for a saga_tool — saga_docs • Rsagacmd - +
- +
@@ -58,20 +58,22 @@

Browse the online documentation for a saga_tool

Arguments

-
saga_tool
+ + +
saga_tool

a saga_tool object

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(Rsagacmd)
 
 saga <- saga_gis()
 
 saga_docs(saga$ta_morphometry$slope_aspect_curvature)
-}
+} # }
@@ -86,15 +88,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_env.html b/docs/reference/saga_env.html index 55c5d4d..ab34e35 100644 --- a/docs/reference/saga_env.html +++ b/docs/reference/saga_env.html @@ -1,12 +1,12 @@ -Parses valid SAGA-GIS libraries and tools into a nested list of functions — saga_env • RsagacmdParses valid SAGA-GIS libraries and tools into a nested list of functions — saga_env • Rsagacmd - +
- +
@@ -69,25 +69,27 @@

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

Arguments

-
saga_bin
+ + +
saga_bin

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

-
opt_lib
+
opt_lib

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.

-
raster_backend
+
raster_backend

A character vector to specify the library to use for handling raster data. Currently, either "terra" or "stars" is supported. The default is "terra".

-
vector_backend
+
vector_backend

A character to specify the library to use for handling vector data. Currently, either "sf", "SpatVector" or "SpatVectorProxy" is supported. The default is "sf".

@@ -95,9 +97,7 @@

Arguments

Value

- - -

A saga environment S3 object containing paths, settings and a nested +

A saga environment S3 object containing paths, settings and a nested list of libraries tools and options.

@@ -113,15 +113,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_execute.html b/docs/reference/saga_execute.html index 9bfad6b..a1cfe62 100644 --- a/docs/reference/saga_execute.html +++ b/docs/reference/saga_execute.html @@ -1,9 +1,9 @@ -Function to execute SAGA-GIS commands through the command line tool — saga_execute • RsagacmdFunction to execute SAGA-GIS commands through the command line tool — saga_execute • Rsagacmd - +
- +
@@ -66,44 +66,44 @@

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

Arguments

-
lib
+ + +
lib

A character specifying the name of SAGA-GIS library to execute.

-
tool
+
tool

A character specifying the name of SAGA-GIS tool to execute.

-
senv
+
senv

A saga environment object.

-
.intern
+
.intern

A logical specifying whether to load the outputs from the SAGA-GIS geoprocessing operation as an R object.

-
.all_outputs
+
.all_outputs

A logical to specify whether to automatically output all results from the selected SAGA tool and load them results as R objects (default = TRUE). If .all_outputs = FALSE then the file paths to store the tool's results will have to be manually specified in the arguments.

-
.verbose
+
.verbose

Option to output all message during the execution of saga_cmd. Overrides the saga environment setting.

-
...
+
...

Named arguments and values for SAGA tool.

Value

- - -

output of SAGA-GIS tool loaded as an R object.

+

output of SAGA-GIS tool loaded as an R object.

@@ -118,15 +118,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_gis.html b/docs/reference/saga_gis.html index 1ebe20c..dec1f27 100644 --- a/docs/reference/saga_gis.html +++ b/docs/reference/saga_gis.html @@ -1,11 +1,11 @@ -Initiate a SAGA-GIS geoprocessor object — saga_gis • RsagacmdInitiate a SAGA-GIS geoprocessor object — saga_gis • Rsagacmd - +
- +
@@ -77,41 +77,43 @@

Initiate a SAGA-GIS geoprocessor object

Arguments

-
saga_bin
+ + +
saga_bin

The path to saga_cmd executable. If this argument is not supplied then an automatic search for the saga_cmd executable will be performed.

-
grid_caching
+
grid_caching

A logical whether to use file caching in saga_cmd geoprocessing operations for rasters that are too large to fit into memory.

-
grid_cache_threshold
+
grid_cache_threshold

A number to act as a threshold (in Mb) before file caching is activated for loaded raster data.

-
grid_cache_dir
+
grid_cache_dir

The path to directory for temporary files generated by file caching. If not provided then the result from `base::tempdir()` is used.

-
cores
+
cores

An integer for the maximum number of processing cores. By default all cores are utilized. Needs to be set to 1 if file caching is activated.

-
raster_backend
+
raster_backend

A character vector to specify the library to use for handling raster data. Supported options are "terra" or "stars". The default is "terra".

-
vector_backend
+
vector_backend

A character to specify the library to use for handling vector data. Currently, "sf", "SpatVector" or "SpatVectorProxy" is supported. The default is "sf", however for large vector datasets, using @@ -120,13 +122,13 @@

Arguments

reading/writing when passing data between R and SAGA-GIS.

-
raster_format
+
raster_format

A character to specify the default format used to save raster data sets that are produced by SAGA-GIS. Available options are one of "SAGA", "SAGA Compressed" or "GeoTIFF". The default is "SAGA".

-
vector_format
+
vector_format

A character to specify the default format used for vector data sets that are produced by SAGA-GIS, and also used to save in-memory objects to be read by SAGA-GIS. Available options are of of "ESRI @@ -136,7 +138,7 @@

Arguments

raise an error.

-
all_outputs
+
all_outputs

A logical to indicate whether to automatically use temporary files to store all output data sets from each SAGA-GIS tool. Default = TRUE. This argument can be overridden by the `.all_outputs` @@ -144,7 +146,7 @@

Arguments

`Rsagacmd::saga_gis()`.

-
intern
+
intern

A logical to indicate whether to load the SAGA-GIS geoprocessing results as an R object, default = TRUE. For instance, if a raster grid is output by SAGA-GIS then this will be loaded as either as @@ -155,19 +157,19 @@

Arguments

argument.

-
opt_lib
+
opt_lib

A character vector with the names of a subset of SAGA-GIS libraries. Used to link only a subset of named SAGA-GIS tool libraries, rather than creating functions for all available tool libraries.

-
temp_path
+
temp_path

The path to use to store any temporary files that are generated as data is passed between R and SAGA-GIS. If not specified, then the system `base::tempdir()` is used.

-
verbose
+
verbose

Logical to indicate whether to output all messages made during SAGA-GIS commands to the R console. Default = FALSE. This argument can be overriden by using the `.verbose` argument on each individual SAGA-GIS tool @@ -176,15 +178,13 @@

Arguments

Value

- - -

A S3 `saga` object containing a nested list of functions for SAGA-GIS +

A S3 `saga` object containing a nested list of functions for SAGA-GIS libraries and tools.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Initialize a saga object
 library(Rsagacmd)
 library(terra)
@@ -201,7 +201,7 @@ 
Examples

 
 # Use Rsagacmd to calculate the Terrain Ruggedness Index
 tri <- saga$ta_morphometry$terrain_ruggedness_index_tri(dem = dem)
-plot(tri)
+plot(tri)
 
 # Optionally run command and do not load result as an R object
 saga$ta_morphometry$terrain_ruggedness_index_tri(dem = dem, .intern = FALSE)
@@ -211,7 +211,7 @@ 
Examples

 # output because this will save disk space by not saving results from tools
 # that output multiple results that you may be want to keep.
 saga <- saga_gis(all_outputs = FALSE)
-}
+} # }
@@ -226,15 +226,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_remove_tmpfiles.html b/docs/reference/saga_remove_tmpfiles.html index 550938d..5edf3e0 100644 --- a/docs/reference/saga_remove_tmpfiles.html +++ b/docs/reference/saga_remove_tmpfiles.html @@ -1,5 +1,5 @@ -Removes temporary files created by Rsagacmd — saga_remove_tmpfiles • RsagacmdRemoves temporary files created by Rsagacmd — saga_remove_tmpfiles • Rsagacmd - +
- +
@@ -74,23 +74,23 @@

Removes temporary files created by Rsagacmd

Arguments

-
h
+ + +
h

Remove temporary files that are older than h (in number of hours).

Value

- - -

Nothing is returned.

+

Nothing is returned.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Remove all temporary files generated by Rsagacmd
 saga_remove_tmpfiles(h = 0)
-}
+} # }
@@ -105,15 +105,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_show_tmpfiles.html b/docs/reference/saga_show_tmpfiles.html index fa8646e..ec3a8ac 100644 --- a/docs/reference/saga_show_tmpfiles.html +++ b/docs/reference/saga_show_tmpfiles.html @@ -1,5 +1,5 @@ -List temporary files created by Rsagacmd — saga_show_tmpfiles • RsagacmdList temporary files created by Rsagacmd — saga_show_tmpfiles • Rsagacmd - +
- +
@@ -70,9 +70,7 @@

List temporary files created by Rsagacmd

Value

- - -

returns the file names of the files in the temp directory that have +

returns the file names of the files in the temp directory that have been generated by Rsagacmd. Note this list of files only includes the primary file extension, i.e. '.shp' for a shapefile without the accessory files (e.g. .prj, .shx etc.).

@@ -80,10 +78,10 @@

Value

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Show all temporary files generated by Rsagacmd
 saga_remove_tmpfiles(h = 0)
-}
+} # }
@@ -98,15 +96,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/saga_version.html b/docs/reference/saga_version.html index b66c389..321bf46 100644 --- a/docs/reference/saga_version.html +++ b/docs/reference/saga_version.html @@ -1,10 +1,10 @@ -Return the installed version of SAGA-GIS — saga_version • RsagacmdReturn the installed version of SAGA-GIS — saga_version • Rsagacmd - +
- +
@@ -60,15 +60,15 @@

Return the installed version of SAGA-GIS

Arguments

-
saga_cmd
+ + +
saga_cmd

The path of the saga_cmd binary.

Value

- - -

A numeric_version with the version of SAGA-GIS found at the cmd path.

+

A numeric_version with the version of SAGA-GIS found at the cmd path.

@@ -83,15 +83,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/save_object.html b/docs/reference/save_object.html index df98162..7c2919c 100644 --- a/docs/reference/save_object.html +++ b/docs/reference/save_object.html @@ -1,10 +1,10 @@ -Generic methods to save R in-memory objects to file to SAGA-GIS to access — save_object • RsagacmdGeneric methods to save R in-memory objects to file to SAGA-GIS to access — save_object • Rsagacmd - +
- +
@@ -60,20 +60,20 @@

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

Arguments

-
x
+ + +
x

An R object.

-
...
+
...

Other parameters such as the temporary directory or the vector/raster format used to write spatial datasets to file.

Value

- - -

A character that specifies the file path to where the R object was +

A character that specifies the file path to where the R object was saved.

@@ -89,15 +89,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/search_saga.html b/docs/reference/search_saga.html index 1864a4e..19ba406 100644 --- a/docs/reference/search_saga.html +++ b/docs/reference/search_saga.html @@ -1,9 +1,9 @@ -Automatic search for the path to a SAGA-GIS installation — search_saga • RsagacmdAutomatic search for the path to a SAGA-GIS installation — search_saga • Rsagacmd - +
- +
@@ -58,9 +58,7 @@

Automatic search for the path to a SAGA-GIS installation

Value

- - -

The path to installed saga_cmd binary.

+

The path to installed saga_cmd binary.

Details

@@ -91,15 +89,15 @@

Details

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/search_tools.html b/docs/reference/search_tools.html index 69becfe..cab259c 100644 --- a/docs/reference/search_tools.html +++ b/docs/reference/search_tools.html @@ -1,9 +1,9 @@ -Search for a SAGA-GIS tool — search_tools • RsagacmdSearch for a SAGA-GIS tool — search_tools • Rsagacmd - +
- +
@@ -58,31 +58,31 @@

Search for a SAGA-GIS tool

Arguments

-
x
+ + +
x

saga object

-
pattern
+
pattern

character, pattern of text to search for within the tool name

Value

- - -

a tibble containing the libraries, names and parameters of the tools +

a tibble containing the libraries, names and parameters of the tools that match the pattern of the search text and their host library

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # initialize Rsagacmd
 saga <- saga_gis()
 
 # search for a tool
 search_tools(x = saga, pattern = "terrain")
-}
+} # }
@@ -97,15 +97,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/show_raster_formats.html b/docs/reference/show_raster_formats.html index bd95655..376b695 100644 --- a/docs/reference/show_raster_formats.html +++ b/docs/reference/show_raster_formats.html @@ -1,12 +1,10 @@ -List the available raster formats that can be set as defaults for a `saga` -object. — show_raster_formats • RsagacmdList the available raster formats that can be set as defaults for a `saga` object. — show_raster_formats • Rsagacmd - +
- +
-

List the available raster formats that can be set as defaults for a `saga` -object.

+

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

Source: R/data-formats.R
@@ -63,9 +60,7 @@

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

Value

- - -

tibble

+

tibble

@@ -91,15 +86,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/show_vector_formats.html b/docs/reference/show_vector_formats.html index 14a28a7..6add973 100644 --- a/docs/reference/show_vector_formats.html +++ b/docs/reference/show_vector_formats.html @@ -1,12 +1,10 @@ -List the available vector formats that can be set as defaults for a `saga` -object. — show_vector_formats • RsagacmdList the available vector formats that can be set as defaults for a `saga` object. — show_vector_formats • Rsagacmd - +
- +
-

List the available vector formats that can be set as defaults for a `saga` -object.

+

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

Source: R/data-formats.R
@@ -63,9 +60,7 @@

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

Value

- - -

tibble

+

tibble

@@ -91,15 +86,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/summarize_tool_params.html b/docs/reference/summarize_tool_params.html index 038ae1e..6dd3d0e 100644 --- a/docs/reference/summarize_tool_params.html +++ b/docs/reference/summarize_tool_params.html @@ -1,12 +1,10 @@ -Interval function used to summarize a `saga_tool` into a tibble that -describes the tools parameters and options — summarize_tool_params • RsagacmdInterval function used to summarize a `saga_tool` into a tibble that describes the tools parameters and options — summarize_tool_params • Rsagacmd - +
- +
-

Interval function used to summarize a `saga_tool` into a tibble that -describes the tools parameters and options

+

Interval function used to summarize a `saga_tool` into a tibble that describes the tools parameters and options

Source: R/tidy.R
@@ -63,16 +60,16 @@

Interval function used to summarize a `saga_tool` into a tibble that

Arguments

-
tool_obj
+ + +
tool_obj

a nested list which constitutes the internals of a saga_tool object

Value

- - -

a tibble

+

a tibble

@@ -87,15 +84,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/tidy.saga.html b/docs/reference/tidy.saga.html index 4b1e20c..75e4bdd 100644 --- a/docs/reference/tidy.saga.html +++ b/docs/reference/tidy.saga.html @@ -1,12 +1,10 @@ -Summarize the libraries that are available within a saga object and -return these as a tibble. — tidy.saga • RsagacmdSummarize the libraries that are available within a saga object and return these as a tibble. — tidy.saga • Rsagacmd - +
- +
-

Summarize the libraries that are available within a saga object and -return these as a tibble.

+

Summarize the libraries that are available within a saga object and return these as a tibble.

Source: R/tidy.R
@@ -58,37 +55,37 @@

Summarize the libraries that are available within a saga object and

- 
# S3 method for saga
+    
# S3 method for class 'saga'
 tidy(x, ...)

Arguments

-
x
+ + +
x

a `saga` object

-
...
+
...

additional arguments. Currently unused.

Value

- - -

a tibble that describes libraries, their descriptions and number of +

a tibble that describes libraries, their descriptions and number of tools that are available in SAGA-GIS.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Initialize a saga object
 saga <- saga_gis()
 
 # tidy the saga object's parameters into a tibble
 tidy(saga)
-}
+} # }
@@ -103,15 +100,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/tidy.saga_library.html b/docs/reference/tidy.saga_library.html index f162cbd..2e5bb0b 100644 --- a/docs/reference/tidy.saga_library.html +++ b/docs/reference/tidy.saga_library.html @@ -1,12 +1,10 @@ -Summarize the tools that are available within a saga library and -return these as a tibble. — tidy.saga_library • RsagacmdSummarize the tools that are available within a saga library and return these as a tibble. — tidy.saga_library • Rsagacmd - +
- +
-

Summarize the tools that are available within a saga library and -return these as a tibble.

+

Summarize the tools that are available within a saga library and return these as a tibble.

Source: R/tidy.R
@@ -58,37 +55,37 @@

Summarize the tools that are available within a saga library and

- 
# S3 method for saga_library
+    
# S3 method for class 'saga_library'
 tidy(x, ...)

Arguments

-
x
+ + +
x

a `saga_library` object

-
...
+
...

additional arguments. Currently unused.

Value

- - -

a tibble that describes the tools and their descriptions within a +

a tibble that describes the tools and their descriptions within a particular SAGA-GIS library.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Initialize a saga object
 saga <- saga_gis()
 
 # tidy the library's parameters into a tibble
 tidy(saga$climate_tools)
-}
+} # }
@@ -103,15 +100,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/tidy.saga_tool.html b/docs/reference/tidy.saga_tool.html index 581069b..3edea25 100644 --- a/docs/reference/tidy.saga_tool.html +++ b/docs/reference/tidy.saga_tool.html @@ -1,12 +1,10 @@ -Summarize the parameters that are available within a SAGA-GIS tool and -return these as a tibble. — tidy.saga_tool • RsagacmdSummarize the parameters that are available within a SAGA-GIS tool and return these as a tibble. — tidy.saga_tool • Rsagacmd - +
- +
-

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

+

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

Source: R/tidy.R
@@ -58,38 +55,38 @@

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

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

Arguments

-
x
+ + +
x

a `saga_tool` object

-
...
+
...

additional arguments. Currently unused.

Value

- - -

a tibble that describes tools, identifiers used by the saga_cmd +

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

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Initialize a saga object
 saga <- saga_gis()
 
 # tidy the tools parameters into a tibble
 tidy(saga$ta_morphometry$slope_aspect_curvature)
-}
+} # }
@@ -104,15 +101,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/tile_geoprocessor.html b/docs/reference/tile_geoprocessor.html index 15476b1..b3f5787 100644 --- a/docs/reference/tile_geoprocessor.html +++ b/docs/reference/tile_geoprocessor.html @@ -1,12 +1,12 @@ -Split a raster grid into tiles for tile-based processing — tile_geoprocessor • RsagacmdSplit a raster grid into tiles for tile-based processing — tile_geoprocessor • Rsagacmd - +
- +
@@ -64,41 +64,41 @@

Split a raster grid into tiles for tile-based processing

Arguments

-
x
+ + +
x

A `saga` object.

-
grid
+
grid

A path to a GDAL-supported raster to apply tiling, or a SpatRaster.

-
nx
+
nx

An integer with the number of x-pixels per tile.

-
ny
+
ny

An integer with the number of y-pixels per tile.

-
overlap
+
overlap

An integer with the number of overlapping pixels.

-
file_path
+
file_path

An optional file file path to store the raster tiles.

Value

- - -

A list of SpatRaster objects representing tiled data.

+

A list of SpatRaster objects representing tiled data.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Initialize a saga object
 saga <- saga_gis()
 
@@ -107,7 +107,7 @@ 
Examples

 
 # Return tiled version of DEM
 tiles <- tile_geoprocessor(x = saga, grid = dem, nx = 20, ny = 20)
-}
+} # }
@@ -122,15 +122,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/update_parameter_file.html b/docs/reference/update_parameter_file.html index 0a6db5a..f7c0447 100644 --- a/docs/reference/update_parameter_file.html +++ b/docs/reference/update_parameter_file.html @@ -1,9 +1,9 @@ -Updates a `parameter` object with file paths to the R data objects. — update_parameter_file • RsagacmdUpdates a `parameter` object with file paths to the R data objects. — update_parameter_file • Rsagacmd - +
- +
@@ -58,29 +58,29 @@

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

Arguments

-
param
+ + +
param

A `parameter` object.

-
temp_path
+
temp_path

A character specifying the tempdir to use for storage (optional).

-
raster_format
+
raster_format

name of raster format in `supported_raster_formats`

-
vector_format
+
vector_format

file extension for vector formats in `supported_vector_formats`

Value

- - -

A `parameter` object with an updated `file` attribute that refers to +

A `parameter` object with an updated `file` attribute that refers to the on-disk file for saga_cmd to access.

@@ -96,15 +96,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/update_parameters_file.html b/docs/reference/update_parameters_file.html index 23ff92f..10d2de1 100644 --- a/docs/reference/update_parameters_file.html +++ b/docs/reference/update_parameters_file.html @@ -1,9 +1,9 @@ -Updates a `parameters` object with file paths to the R data objects. — update_parameters_file • RsagacmdUpdates a `parameters` object with file paths to the R data objects. — update_parameters_file • Rsagacmd - +
- +
@@ -58,28 +58,28 @@

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

Arguments

-
temp_path
+ + +
params
+

A `parameters` object.

+ + +
temp_path

A character specifying the tempdir to use for storage (optional).

-
raster_format
+
raster_format

file extension for raster formats

-
vector_format
+
vector_format

file extension for vector formats

- -
param
-

A `parameters` object.

-

Value

- - -

A `parameters` object with updated `file` attributes that refers to +

A `parameters` object with updated `file` attributes that refers to the on-disk file for saga_cmd to access.

@@ -95,15 +95,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/reference/update_parameters_tempfiles.html b/docs/reference/update_parameters_tempfiles.html index fae7963..6a55354 100644 --- a/docs/reference/update_parameters_tempfiles.html +++ b/docs/reference/update_parameters_tempfiles.html @@ -1,12 +1,10 @@ -Update a `parameters` object using temporary files for any unspecified output -parameters — update_parameters_tempfiles • RsagacmdUpdate a `parameters` object using temporary files for any unspecified output parameters — update_parameters_tempfiles • Rsagacmd - +
- +
-

Update a `parameters` object using temporary files for any unspecified output -parameters

+

Update a `parameters` object using temporary files for any unspecified output parameters

Source: R/parameters.R
@@ -63,27 +60,27 @@

Update a `parameters` object using temporary files for any unspecified outpu

Arguments

-
params
+ + +
params

A `parameters` object.

-
temp_path
+
temp_path

A character with the tempdir.

-
raster_format
+
raster_format

A character specifying the raster format.

-
vector_format
+
vector_format

A character specifying the vector format.

Value

- - -

A `parameters` object.

+

A `parameters` object.

@@ -98,15 +95,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 35f4b08..81653e2 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,156 +1,53 @@ - - - - /404.html - - - /LICENSE-text.html - - - /authors.html - - - /index.html - - - /news/index.html - - - /reference/Rsagacmd-package.html - - - /reference/Rsagacmd.html - - - /reference/Rsagacmd_usage.html - - - /reference/check_output_format.html - - - /reference/convert_sagaext_r.html - - - /reference/create_alias.html - - - /reference/create_function.html - - - /reference/create_tool.html - - - /reference/create_tool_overrides.html - - - /reference/drop_parameters.html - - - /reference/extract_tool.html - - - /reference/index.html - - - /reference/mrvbf_threshold.html - - - /reference/parameter.html - - - /reference/parameters.html - - - /reference/parse_options.html - - - /reference/print.saga_tool.html - - - /reference/read_grid.html - - - /reference/read_grid_list.html - - - /reference/read_output.html - - - /reference/read_shapes.html - - - /reference/read_srtm.html - - - /reference/read_table.html - - - /reference/reexports.html - - - /reference/run_cmd.html - - - /reference/saga_configure.html - - - /reference/saga_docs.html - - - /reference/saga_env.html - - - /reference/saga_execute.html - - - /reference/saga_gis.html - - - /reference/saga_remove_tmpfiles.html - - - /reference/saga_show_tmpfiles.html - - - /reference/saga_version.html - - - /reference/save_object.html - - - /reference/search_saga.html - - - /reference/search_tools.html - - - /reference/show_raster_formats.html - - - /reference/show_vector_formats.html - - - /reference/summarize_tool_params.html - - - /reference/tidy.saga.html - - - /reference/tidy.saga_library.html - - - /reference/tidy.saga_tool.html - - - /reference/tile_geoprocessor.html - - - /reference/update_parameter_file.html - - - /reference/update_parameters_file.html - - - /reference/update_parameters_tempfiles.html - + +/404.html +/LICENSE-text.html +/authors.html +/index.html +/news/index.html +/reference/Rsagacmd.html +/reference/Rsagacmd_usage.html +/reference/check_output_format.html +/reference/convert_sagaext_r.html +/reference/create_alias.html +/reference/create_function.html +/reference/create_tool.html +/reference/create_tool_overrides.html +/reference/drop_parameters.html +/reference/extract_tool.html +/reference/index.html +/reference/mrvbf_threshold.html +/reference/parameter.html +/reference/parameters.html +/reference/parse_options.html +/reference/print.saga_tool.html +/reference/read_grid.html +/reference/read_grid_list.html +/reference/read_output.html +/reference/read_shapes.html +/reference/read_srtm.html +/reference/read_table.html +/reference/reexports.html +/reference/run_cmd.html +/reference/saga_configure.html +/reference/saga_docs.html +/reference/saga_env.html +/reference/saga_execute.html +/reference/saga_gis.html +/reference/saga_remove_tmpfiles.html +/reference/saga_show_tmpfiles.html +/reference/saga_version.html +/reference/save_object.html +/reference/search_saga.html +/reference/search_tools.html +/reference/show_raster_formats.html +/reference/show_vector_formats.html +/reference/summarize_tool_params.html +/reference/tidy.saga.html +/reference/tidy.saga_library.html +/reference/tidy.saga_tool.html +/reference/tile_geoprocessor.html +/reference/update_parameter_file.html +/reference/update_parameters_file.html +/reference/update_parameters_tempfiles.html + diff --git a/man/figures/README-using-pipes-1.png b/man/figures/README-using-pipes-1.png new file mode 100644 index 0000000..9ae58ab Binary files /dev/null and b/man/figures/README-using-pipes-1.png differ diff --git a/man/figures/README-using-tempfiles-1.png b/man/figures/README-using-tempfiles-1.png new file mode 100644 index 0000000..dcc9f47 Binary files /dev/null and b/man/figures/README-using-tempfiles-1.png differ