Adds a defined variable and value to the global search path

Description

Adds a variable to the global search path of the current environment

Usage

add2Path(newPath)

Arguments

Author(s)

Chris Reudenbach

Examples

## Not run: 
# add path
add2Path('pathtosomewhere')

## End(Not run)

Extent folder list by git repository

Description

Extent folder list by git repository and create subdirectories according to default values.

Usage

addGitFolders(folders, git_repository = NULL, git_subfolders = NULL)

Arguments

Examples

## Not run: 
addGitFolders(folders = c('data', 'data/tmp'), git_repository = 'myproject')

## End(Not run)

Compile folder list and create folders

Description

Compile folder list with absolut paths and create folders if necessary.

Usage

createFolders(root_folder, folders, create_folders = TRUE)

Arguments

Value

List with folder paths and names.

Examples

## Not run: 
 createFolders(root_folder = tempdir(), folders = c('data/', 'data/tmp/'))

## End(Not run)
# Create folder list and set variable names pointing to the path values

Create list of metadata from project environment.

Description

Create list of metadata from project environment.

Usage

createMeta(prj_name)

Arguments

Value

list of metadata.

Examples

## Not run: 
createMeta(tempdir())

## End(Not run)

Create files or scripts from templates

Description

Create files or scripts from brew templates supplied with the package.

Usage

createScript(
  new_file = file.path(tempdir(), "tmp.R"),
  template = c("script_function", "script_control"),
  notes = TRUE,
  template_path = system.file(sprintf("templates/%s.brew", template[1]), package =
    "link2GI")
)

Arguments

Examples

## Not run: 
createScript()

## End(Not run)

Search recursivly existing 'GDAL binaries' installation(s) at a given drive/mountpoint

Description

Provides an list of valid 'GDAL' installation(s) on your 'Windows' system. There is a major difference between osgeo4W and stand_alone installations. The functions trys to find all valid installations by analysing the calling batch scripts.

Usage

findGDAL(searchLocation = "default", quiet = TRUE)

Arguments

Value

A dataframe with the 'GDAL' root folder(s), and command line executable(s)

Author(s)

Chris Reudenbach

Examples

run = FALSE
if (run) {
# find recursively all existing 'GDAL' installations folders starting 
# at the default search location
findGDAL()
}

Returns attributes of valid 'GRASS GIS' installation(s) on the system.

Description

Retrieve a list of valid 'GRASS GIS' installation(s) on your system. On Windows, uses searchGRASSW() (cmd-free). On Unix, uses searchGRASSX().

Usage

findGRASS(searchLocation = "default", ver_select = FALSE, quiet = TRUE)

Arguments

Value

FALSE or data.frame(instDir, version, installation_type)

Locate Orfeo ToolBox (OTB) installations

Description

Dispatcher that calls the OS-specific search function and returns a normalized installations table.

Usage

findOTB(searchLocation = NULL, quiet = TRUE)

Arguments

Value

data.frame of installations or FALSE.

Search recursively existing 'SAGA GIS' installation(s) at a given drive/mount point

Description

Provides an list of valid 'SAGA GIS' installation(s) on your 'Windows' system. There is a major difference between osgeo4W and stand_alone installations. The functions tries to find all valid installations by analyzing the calling batch scripts.

Usage

findSAGA(searchLocation = "default", quiet = TRUE)

Arguments

Value

A dataframe with the 'SAGA GIS' root folder(s), version name(s) and installation type code(s)

Author(s)

Chris Reudenbach

Examples

## Not run: 
# find recursively all existing 'SAGA GIS' installation folders starting 
# at the default search location
findSAGA()

## End(Not run)

Checks if x is of type raster,terra,sf or sp

Description

Checks if x is a raster or sp object

Usage

getSpatialClass(obj)

Arguments

Author(s)

Chris Reudenbach

Examples

## Not run: 
# add path
getSpatialClass(x)

## End(Not run)

Select "newest" OTB installation row index

Description

Heuristic: parse a version-like token from binDir/baseDir path. If none can be parsed, fall back to the last row.

Usage

getrowotbVer(paths)

Arguments

Value

Integer row index (1..length(paths))

Converts from an existing 'GRASS' environment an arbitrary vector dataset into a sf object

Description

Converts from an existing 'GRASS' environment an arbitrary vector dataset into a sf object

Usage

gvec2sf(x, obj_name, gisdbase, location, gisdbase_exist = TRUE)

Arguments

Note

have a look at the sf capabilities to read direct from sqlite

Author(s)

Chris Reudenbach

Examples

run = FALSE
if (run) {
## example 
require(sf)
require(sp)
require(link2GI)
data(meuse)
meuse_sf = st_as_sf(meuse, 
                    coords = c('x', 'y'), 
                    crs = 28992, 
                    agr = 'constant')


# write data to GRASS and create gisdbase
sf2gvec(x = meuse_sf,
        obj_name = 'meuse_R-G',
        gisdbase = '~/temp3/',
        location = 'project1')

# read from existing GRASS          
gvec2sf(x = meuse_sf,
        obj_name = 'meuse_r_g',
        gisdbase = '~/temp3',       
        location = 'project1')

}

Simple creation and reproduction of an efficient project environment

Description

Set up the project environment with a defined folder structure, an RStudio project, initial scripts and configuration files and optionally with Git and Renv support.

Usage

initProj(
  root_folder = ".",
  folders = NULL,
  init_git = NULL,
  init_renv = NULL,
  code_subfolder = c("src", "src/functions", "src/configs"),
  global = FALSE,
  openproject = NULL,
  newsession = TRUE,
  standard_setup = "baseSpatial",
  loc_name = NULL,
  ymlFN = NULL,
  appendlibs = NULL,
  OpenFiles = NULL
)

Arguments

Details

The function uses [setupProj] for setting up the folders. Once the project is creaeted, manage the overall configuration of the project by the 'src/functions/000_settings.R script'. It is sourced at the begining of the template scripts that are created by default. Define additional constans, required libraries etc. in the 000_settings.R at any time. If additonal folders are required later, just add them manually. They will be parsed as part of the 000_settings.R and added to a variable called dirs that allows easy acces to any of the folders. Use this variable to load/save data to avoid any hard coded links in the scripts except the top-level root folder which is defined once in the main control script located at src/main.R.

Value

dirs, i.e. a list containing the project paths.

Note

For yaml based setup you need to use one of the default configurations c('base', 'baseSpatial','advancedSpatial') or you provide a yaml file this MUST contain the standard_setup arguments, where mysetup is the yaml root, all other items are mandatory keywords that can be filled in as needed.

mysetup:
  dataFolder:  
  docsFolder:  
  tmpFolder:   
  init_git: true/false 
  init_renv: true/false 
  code_subfolder: ['src', 'src/functions' , 'src/config'] 
  global: true/false 
  libs: 
  create_folders: true/false
  files:

Alternatively you may set default_setup to NULL and provide the arguments via command line.

Examples

## Not run: 
root_folder <- tempdir() # Mandatory, variable must be in the R environment.
dirs <- initProj(root_folder = root_folder, standard_setup = 'baseSpatial')

## End(Not run)

convenient function to establish all link2GI links

Description

brute force search, find and linkl of all link2GI link functions. This is helpfull if yor system is well setup and the standard linkage procedure will provide the correct linkages.

Usage

linkAll(
  links = NULL,
  simple = TRUE,
  linkItems = c("saga", "grass", "otb", "gdal"),
  sagaArgs = "default",
  grassArgs = "default",
  otbArgs = "default",
  gdalArgs = "default",
  quiet = FALSE
)

Arguments

Note

You may also use the full list of arguments that is made available from the link2GI package, but it is strongly recommended in this case to use directly the single linkage functions from link2GI.

Examples

## Not run: 
# required packages
require(link2GI)

# search, find and create the links to all supported  GI software
giLinks<-linkAll()

# makes the GDAL linkage verbose
giLinks<-linkAll(gdalArgs= 'quiet = TRUE') 


## End(Not run)

Locate and set up 'GDAL' API bindings

Description

Locate and set up 'GDAL - Geospatial Data Abstraction Librar' API bindings

Usage

linkGDAL(
  bin_GDAL = NULL,
  searchLocation = NULL,
  ver_select = FALSE,
  quiet = TRUE,
  returnPaths = TRUE
)

Arguments

Details

It looks for the gdalinfo(.exe) file. If the file is found in a bin folder it is assumed to be a valid 'GDAL' binary installation.

if called without any parameter linkGDAL() it performs a full search over the hard drive C:. If it finds one or more 'GDAL' binaries it will take the first hit. You have to set ver_select = TRUE for an interactive selection of the preferred version.

Value

add gdal paths to the environment and creates global variables path_GDAL

Note

You may also set the path manually. Using a 'OSGeo4W64' https://trac.osgeo.org/osgeo4w/ installation it is typically C:/OSGeo4W64/bin/

Author(s)

Chris Reudenbach

Examples

## Not run: 
# call if you do not have any idea if and where GDAL is installed
gdal<-linkGDAL()
if (gdal$exist) {
# call it for a default OSGeo4W installation of the GDAL
print(gdal)
}

## End(Not run)

Locate and set up GRASS GIS API bindings

Description

Initializes a GRASS GIS 7.x/8.x runtime environment and prepares a valid temporary or permanent GRASS location and mapset for use from R.

Usage

linkGRASS(
  x = NULL,
  epsg = NULL,
  default_GRASS = NULL,
  search_path = NULL,
  ver_select = FALSE,
  gisdbase_exist = FALSE,
  gisdbase = NULL,
  use_home = FALSE,
  location = NULL,
  spatial_params = NULL,
  resolution = NULL,
  quiet = TRUE,
  returnPaths = TRUE
)

Arguments

Details

The function detects installed GRASS versions, initializes required environment variables, and derives spatial reference information either from an existing spatial object or from manually provided parameters.

GRASS requires a fully initialized runtime environment (PATH, GISBASE, PROJ, GDAL). On some platforms, R must be started from a shell where GRASS is already available.

The function ensures that 'PROJ_INFO' and 'PROJ_UNITS' are written by explicitly calling 'g.proj' before region initialization.

Value

A list describing the selected GRASS installation and status, or 'NULL' if no valid installation was found.

Author(s)

Chris Reudenbach

See Also

initGRASS, execGRASS

Examples

## Not run: 
library(link2GI)
library(sf)

# Example 1: initialize a temporary GRASS location from an sf object
nc <- st_read(system.file("shape/nc.shp", package = "sf"))
grass <- linkGRASS(nc)

# Example 2: select GRASS version interactively if multiple installations exist
linkGRASS(nc, ver_select = TRUE)

# Example 3: create a permanent GRASS location
root <- tempdir()
linkGRASS(
  x        = nc,
  gisdbase = root,
  location = "project1"
)

# Example 4: link to an existing GRASS location without recreating it
linkGRASS(
  gisdbase        = root,
  location        = "project1",
  gisdbase_exist  = TRUE
)

# Example 5: manual setup using spatial parameters only
epsg <- 28992
linkGRASS(
  spatial_params = c(178605, 329714, 181390, 333611),
  epsg = epsg
)

## End(Not run)

Locate and describe Orfeo ToolBox (OTB) API bindings

Description

Public wrapper that dispatches to OS-specific implementations. No PATH mutation, no environment setup here.

Dispatcher that selects the platform-specific OTB locator. This function is non-invasive: it does NOT modify PATH or ENV.

Usage

linkOTB(
  bin_OTB = NULL,
  root_OTB = NULL,
  type_OTB = NULL,
  searchLocation = NULL,
  ver_select = FALSE,
  quiet = TRUE,
  returnPaths = TRUE
)

linkOTB(
  bin_OTB = NULL,
  root_OTB = NULL,
  type_OTB = NULL,
  searchLocation = NULL,
  ver_select = FALSE,
  quiet = TRUE,
  returnPaths = TRUE
)

Arguments

Value

A gili list describing the selected OTB installation.

Locate and describe Orfeo ToolBox (OTB) bindings (Linux/macOS)

Description

Internal OS-specific implementation. Returns a gili list with a valid 'launcher' (otbApplicationLauncherCommandLine) if present.

Usage

linkOTB_linux(
  bin_OTB = NULL,
  root_OTB = NULL,
  type_OTB = NULL,
  searchLocation = NULL,
  ver_select = FALSE,
  quiet = TRUE,
  returnPaths = TRUE
)

Arguments

Value

gili list.

Identifies SAGA GIS Installations and returns linking Informations

Description

Finds the existing SAGA GIS installation(s), generates and sets the necessary path and system variables for a seamless use of the command line calls of the 'SAGA GIS' CLI API, setup valid system variables for calling a default rsaga.env and by this makes available the RSAGA wrapper functions.
All existing installation(s) means that it looks for the saga_cmd or saga_cmd.exe executables. If the file is found it is assumed to be a valid 'SAGA GIS' installation. If it is called without any argument the most recent (i.e. highest) SAGA GIS version will be linked.

Usage

linkSAGA(
  default_SAGA = NULL,
  searchLocation = "default",
  ver_select = FALSE,
  quiet = TRUE,
  returnPaths = TRUE
)

Arguments

Value

A list containing the selected RSAGA path variables $sagaPath,$sagaModPath,$sagaCmd and potentially other installations $installed

Note

The 'SAGA GIS' wrapper RSAGA package was updated several times however it covers currently (May 2014) only 'SAGA GIS' versions from 2.3.1 LTS - 8.4.1 The fast evolution of 'SAGA GIS' makes it highly impracticable to keep the wrapper adaptions in line (currently 9.4). RSAGA will meet all linking needs perfectly if you use 'SAGA GIS' versions from 2.0.4 - 7.5.0.
However you must call rsaga.env using the rsaga.env(modules = saga$sagaModPath) assuming that saga contains the returnPaths of linkSAGA In addition the very promising Rsagacmd wrapper package is providing a new list oriented wrapping tool.

Examples

## Not run: 

# call if you do not have any idea if and where SAGA GIS is installed
# it will return a list with the selected and available SAGA installations
# it prepares the system for running the selected SAGA version via RSAGA or CLI
linkSAGA()

# overriding the default environment of rsaga.env call 

saga<-linkSAGA()
if (saga$exist) {
require(RSAGA)
RSAGA::rsaga.env(path = saga$installed$binDir[1],modules = saga$installed$moduleDir[1])
}

## End(Not run)

Load data from rds format and associated yaml metadata file.

Description

Load data from rds format and associated yaml metadata file.

Usage

loadEnvi(file_path)

Arguments

Value

list of 2 containing data and metadata.

Examples

## Not run: 
a <- 1
meta <- list(a = 'a is a variable')
saveEnvi(a, file.path(tempdir(), 'test.rds'), meta)
b <- loadEnvi(file.path(tempdir(), 'test.rds'))

## End(Not run)

Load libraries and try to install missing ones

Description

Load libaries in the R environment and try to install misssing ones.

Usage

loadLibraries(libs)

Arguments

Value

List indicating which library has been loaded successfully.

Examples

## Not run: 
# loadLibraries(libs = C('link2GI'))

## End(Not run)

Generates a variable with a certain value in the R environment

Description

Generates a variable with a certain value in the R environment

Usage

makGlobalVar(name, value)

Arguments

Examples

## Not run: 

# creates the global var \code{pathToData} with the value \code{~/home/data}
makGlobalVar('pathToData','~/home/data') 


## End(Not run)

Generates a variable with a certain value in the R environment

Description

Generates a variable with a certain value in the R environment.

Usage

makeGlobalVariable(names, values)

Arguments

Examples

## Not run: 
# creates the global variable \code{path_data} with the value \code{~/data}
makeGlobalVariable(names = 'path_data', values = '~/data')

## End(Not run)

Build package manually

Description

This function was specifically designed to build a package from local source files manually, i.e., without using the package building functionality offered e.g. by RStudio.

Usage

manuallyBuild(dsn = getwd(), pkgDir = "H:/Dokumente", document = TRUE, ...)

Arguments

Details

NOTE the default setting are focussing HRZ environment at Marburg University

Author(s)

Florian Detsch, Chris Reudenbach

Examples

## Not run: 
## when in a package directory, e.g. '~/link2GI' 
manuallyBuild()

## End(Not run)

Orfeo ToolBox (OTB) helpers: introspection and command construction

Description

Public helpers to introspect OTB applications (by parsing '-help' output) and to build/modify command lists consumable by [runOTB()].

Calls the OTB application with '-help' and parses the 'Parameters:' block into a parameter table.

Normalizes the parsed parameter table (from [otb_capabilities()]) into a stable schema used for command building.

Convenience accessor based on [otb_args_spec()].

Like [otb_required()], but can ensure that a best-effort output key is included.

Convenience accessor based on [otb_args_spec()]. Returns a named list of optional parameters with 'NA_character_' placeholders or default values.

Creates a command list suitable for [runOTB()], with mandatory parameters always present as 'NA_character_' placeholders. Optional parameters can be omitted, filled with defaults, or included as 'NA_character_'.

Prints a compact overview (help line count, parameter count) and the full normalized parameter spec table.

Updates 'cmd[[key]]' to a normalized output path. If the parameter is pixel-typed ('[pixel]' in OTB help), the value is set as 'c(path, pixel_type)'.

Usage

otb_capabilities(algo, gili = NULL, include_param_help = FALSE)

otb_args_spec(algo, gili = NULL)

otb_required(algo, gili = NULL)

otb_required_with_output(algo, gili = NULL, enforce_output = TRUE)

otb_optional(algo, gili = NULL, with_defaults = TRUE)

otb_build_cmd(
  algo,
  gili = NULL,
  include_optional = c("none", "defaults", "all_na"),
  require_output = TRUE
)

otb_show(algo, gili = NULL)

otb_set_out(
  cmd,
  gili = NULL,
  key = "out",
  path,
  pixel_type = NULL,
  overwrite = TRUE,
  create_dir = TRUE
)

Arguments

Details

The functions in this family are **non-invasive**: they do not mutate 'PATH' or global environment variables. They rely on a valid OTB descriptor as returned by [linkOTB()]. On Linux/macOS the implementation expects a working launcher ('gili$launcher') and uses an explicit environment map internally.

The common command representation is a list where: - 'cmd[[1]]' is the application name (character scalar), e.g. '"DimensionalityReduction"'. - subsequent named entries represent CLI parameters **without** a leading dash, e.g. 'cmd[["in"]]', 'cmd[["out"]]', 'cmd[["method"]]'. - values are character scalars, 'NA_character_' (placeholder), or for pixel-typed output parameters a character vector 'c(path, pixel_type)'.

This function performs basic checks on directory existence and overwrite policy.

Value

A list with components: - 'text': character vector of help lines. - 'params': data.frame parsed from the 'Parameters:' block. - 'param_help': 'NULL' or named list of character vectors (per-parameter help).

A data.frame with (at least) the columns: 'key', 'type', 'mandatory', 'has_pixel', 'pixel_default', 'has_default', 'default', 'class', 'desc'.

Character vector of mandatory parameter keys.

Character vector of required parameter keys (including output if enforced).

Named list of optional parameters.

A command list with 'cmd[[1]] == algo' and named entries for parameters.

Invisibly returns a list with components 'caps' and 'spec'.

The modified command list.

Introspection

- [otb_capabilities()] returns the raw help text and a parsed parameter table. - [otb_args_spec()] normalizes the parsed table into a stable schema used by the helper functions below.

Command helpers

- [otb_required()], [otb_required_with_output()], [otb_optional()] - [otb_build_cmd()] creates a template command list using the spec. - [otb_set_out()] sets/validates an output parameter path (optionally pixel-typed). - [otb_show()] prints a compact overview for interactive use.

See Also

[linkOTB()], [runOTB()], [runOTB_isolated()]

Usually for internally usage get 'GRASS GIS' and rgrass parameters on 'Windows' OS

Description

Initialize the enviroment variables on a 'Windows' OS for using 'GRASS GIS' via rgrass

Usage

paramGRASSw(
  set_default_GRASS = NULL,
  DL = "C:/",
  ver_select = FALSE,
  quiet = TRUE
)

Arguments

Details

The concept is very straightforward but for an all days usage pretty helpful. You need to provide a terra or a sf object. The derived properties are used to initialize a temporary but static rgrass environment. During the rsession you will have full access to GRASS both via the wrapper package as well as the command line. paramGRASSw initializes the usage of GRASS.

Examples

run = FALSE
if (run) {
# automatic retrieval of valid 'GRASS GIS' environment settings 
# if more than one is found the user has to choose.
paramGRASSw()

# typical OSGeo4W64 installation
paramGRASSw(c('C:/OSGeo4','grass7.8','osgeo4W'))
}

Usually for internally usage, get 'GRASS GIS' and rgrass parameters on 'Linux' OS

Description

Initialize and set up rgrass for 'Linux'

Usage

paramGRASSx(
  set_default_GRASS = NULL,
  MP = "/usr/bin",
  ver_select = FALSE,
  quiet = TRUE
)

Arguments

Details

During the rsession you will have full access to GRASS7 GIS via the rgrass wrapper. Additionally you may use also use the API calls of GRASS via the command line.

Examples

run = FALSE
if (run) {
# automatic retrieval of the GRASS environment settings
paramGRASSx()


# typical stand_alone installation
paramGRASSx('/usr/bin/grass72')

# typical user defined installation (compiled sources)
paramGRASSx('/usr/local/bin/grass72')
}

Linux/macOS: lists plugin libs ⁠otbapp_*.so⁠, ⁠otbapp_*.dylib⁠, ⁠otbapp_*.dll⁠ Windows: lists wrappers ⁠otbcli_<Algo>.ps1⁠, ⁠otbcli_<Algo>.bat⁠, ⁠otbcli_<Algo>.exe⁠# Retrieve available OTB applications

Description

Linux/macOS: lists 'otbapp_*.{so,dylib,dll}' under OTB_APPLICATION_PATH derived from OTB root.

Usage

parseOTBAlgorithms(gili = NULL)

Arguments

Details

Windows: lists wrappers 'otbcli_<Algo>.{ps1,bat,exe}' in 'gili$pathOTB' (binDir). #'

Value

Character vector of application names.

Retrieve the argument list from an OTB application

Description

Legacy convenience wrapper that returns a list containing: - first element: algo name - named entries: parameter defaults (if any) and "mandatory" markers - '$help': per-parameter help text (if available)

Usage

parseOTBFunction(algo = NULL, gili = NULL)

Arguments

Details

Under the hood this uses the NEW introspection API: [otb_capabilities()] and [otb_args_spec()].

Value

List (legacy format).

Run an OTB application (new workflow C)

Description

Executes an Orfeo ToolBox application via the launcher/wrapper described by 'gili' (typically returned by [linkOTB()]). This wrapper is non-invasive: it does not permanently modify PATH or the user environment.

Usage

runOTB(
  otbCmdList,
  gili = NULL,
  retRaster = TRUE,
  retCommand = FALSE,
  quiet = TRUE
)

Arguments

Details

The command is provided as a list in "link2GI style": - 'otbCmdList[[1]]' is the application name (e.g., '"DimensionalityReduction"') - named elements are OTB parameter keys (without leading '-')

Parameter values can be: - a scalar character/numeric (converted to character) - 'NA' / 'NA_character_' to omit the parameter - for pixel-typed outputs: a character vector of length 2 'c("<path>", "<pixel_type>")' (e.g. 'c("out.tif","float")')

Value

Depending on 'retCommand' / 'retRaster', returns either a command string, a 'terra::SpatRaster', or a character vector/status describing the produced output.

Execute an OTB application in an isolated OTB environment (mainly Windows)

Description

- Windows: dot-sources 'otbenv.ps1' (preferred) or calls 'otbenv.bat', then runs 'otbcli' within the same shell session. - Linux/macOS: delegates to [runOTB()] (launcher + explicit env already used).

Usage

runOTB_isolated(otbCmdList, gili = NULL, retCommand = FALSE, quiet = TRUE)

Arguments

Value

If 'retCommand=TRUE', a character scalar command line. Otherwise an invisible status code.

Saves data in rds format and adds a yaml metadata file.

Description

Saves data in rds format and saves metadata in a corresponding yaml file.

Usage

saveEnvi(variable, file_path, meta)

Arguments

Examples

## Not run: 
a <- 1
meta <- list(a = 'a is a variable')
saveEnvi(a, file.path(tempdir(), 'test.rds'), meta)

## End(Not run)

Search recursively for valid 'GDAL' installation(s) on a 'Windows' OS

Description

Search for valid 'GDAL' installations on a 'Windows' OS

Usage

searchGDALW(DL = "C:/", quiet = TRUE)

Arguments

Value

A dataframe with the 'GDAL' root folder(s) the version name(s) and the installation type(s).

Author(s)

Chris Reudenbach

Examples

run = FALSE
if (run) {
# get all valid GDAL installation folders and params
searchGDALW()
}

Search recursively for valid GDAL installation(s) on Linux/macOS

Description

Searches for an executable 'gdalinfo' and returns a normalized installations table plus best-effort lists of GDAL binaries ('gdal*') and python tools ('*.py') found alongside the detected 'gdalinfo'.

Usage

searchGDALX(MP = "default", quiet = TRUE)

Arguments

Details

This implementation is portable: it does NOT use GNU-only 'find' primaries such as '-readable', and it uses 'system2(..., args=...)' with proper token separation (no shell parsing assumptions).

Value

A list with:

gdalInstallations

data.frame with columns 'binDir', 'baseDir', 'installation_type'.

bin

list of data.frames (column 'gdal_bin') with detected GDAL binaries per installation.

py

list of data.frames (column 'gdal_py') with detected GDAL python tools per installation.

Examples

## Not run: 
x <- searchGDALX()
x$gdalInstallations

## End(Not run)

Search for valid GRASS GIS installations on Windows

Description

Searches for GRASS GIS installations on **Windows** using a *bounded* set of plausible installation roots (no full-disk crawl). The function supports:

• OSGeo4W / QGIS-style layouts via <root>/apps/grass/grass*/etc/VERSIONNUMBER

• Standalone GRASS installs via <Program Files>/GRASS GIS */etc/VERSIONNUMBER

• Optional per-user OSGeo4W installs under <USERPROFILE>/AppData/Local/Programs/OSGeo4W

Usage

searchGRASSW(DL = "C:/", quiet = TRUE)

searchGRASSW(DL = "C:/", quiet = TRUE)

Arguments

Details

The argument DL can be a full path or a Windows drive root (e.g. "C:" or "C:/"). Drive roots are expanded to a fixed set of candidate directories: OSGeo4W64, OSGeo4W, Program Files, Program Files (x86).

This function is intentionally conservative to remain fast and deterministic on large Windows volumes. It does **not** recurse the entire drive.

If multiple installations are present under the searched roots, all are returned. Version parsing extracts the first x.y[.z...] pattern from the first line of VERSIONNUMBER.

Value

Returns FALSE if no installation was detected. Otherwise returns a data.frame with columns:

instDir

Root directory of the installation candidate.

version

Parsed version string (from VERSIONNUMBER) or NA.

installation_type

One of "osgeo4w", "qgis", "standalone".

The result is sorted by decreasing semantic version (unknown versions treated as 0.0.0).

'FALSE' or a 'data.frame' with columns 'instDir', 'version', 'installation_type'.

Examples

## Not run: 
# Search from the C: drive root (bounded roots, no full-disk scan)
searchGRASSW("C:/", quiet = FALSE)

# Search a concrete directory only
searchGRASSW("C:/OSGeo4W64", quiet = FALSE)

# Drive letter without slash is accepted
searchGRASSW("C:", quiet = TRUE)

## End(Not run)

Search for valid GRASS GIS installation(s) on Unix (Linux/macOS)

Description

Strategy: 1) Prefer 'grass –config path' (returns GISBASE on modern GRASS) 2) Fallback: locate 'grass' via 'Sys.which()', then infer common GISBASE paths

Usage

searchGRASSX(MP = "default", quiet = TRUE)

Arguments

Value

FALSE or data.frame(instDir, version, installation_type)

Search for OTB installations on Windows (bounded, cmd-free)

Description

Detects Orfeo Toolbox (OTB) installations on Windows using a bounded set of plausible roots (no full-disk crawl). Modern standalone bundles (OTB 9.x) are detected by the presence of:

• an environment script: otbenv.ps1 (preferred) or otbenv.bat

• a launcher: bin/otbApplicationLauncherCommandLine.exe

• at least one CLI wrapper in bin/: otbcli_*.ps1, otbcli_*.bat, or otbcli_*.exe

Usage

searchOTBW(searchLocation = "C:/", DL = NULL, maxdepth = 8L, quiet = FALSE)

Arguments

Details

Backward compatibility: older callers may pass DL instead of searchLocation. Internally, DL is treated as an alias for searchLocation.

Value

A data.frame with one row per detected installation and columns:

binDir

Normalized path to <root>/bin.

baseDir

Normalized OTB root directory.

otbCmd

Path to a detected CLI wrapper (ps1/bat/exe).

envScript

Path to otbenv.ps1 or otbenv.bat.

launcher

Path to otbApplicationLauncherCommandLine.exe.

installation_type

Classification string (e.g., "OTB_STANDALONE_PS1").

Examples

## Not run: 
# bounded search under C:/
searchOTBW("C:/", quiet = FALSE)

# legacy alias
searchOTBW(DL = "C:/", quiet = FALSE)

## End(Not run)

Search recursively for valid OTB installation(s) on Linux/macOS

Description

Searches for an executable 'otbcli' and validates presence of 'otbApplicationLauncherCommandLine' in the same bin folder (or base/bin).

Usage

searchOTBX(MP = "default", quiet = TRUE)

Arguments

Value

data.frame with OTB installations (or FALSE).

Searches recursively for existing 'Windows' 'SAGA GIS' installation(s)

Description

Searches recursively for existing 'SAGA GIS' installation(s) on a given 'Windows' drive

Usage

searchSAGAW(DL = "C:/", quiet = TRUE)

Arguments

Value

A data frame containing the 'SAGA GIS' root folder(s), the version name(s) and the installation type(s)

Author(s)

Chris Reudenbach

Examples

## Not run: 
#### Examples how to use searchSAGAW 

# get all valid SAGA installation folders and params
searchSAGAW()

## End(Not run)

Searches recursively for existing 'Windows' 'SAGA GIS' installation(s)

Description

Search for valid 'GRASS GIS' installations at a given 'Linux' mount point

Usage

searchSAGAX(MP = "/usr/bin", quiet = TRUE)

Arguments

Value

A data frame containing the 'SAGA GIS' root folder(s), the version name(s) and the installation type(s)

Author(s)

Chris Reudenbach

Examples

## Not run: 
#### Examples how to use searchSAGAX

# get all valid SAGA installation folders and params
searchSAGAX()

## End(Not run)

Usually for internally usage, initializes and set up access to the 'GDAL' command line interface

Description

Initializes and set up access to the 'GDAL' command line interface

Usage

setenvGDAL(bin_GDAL = NULL)

Arguments

Value

Adds 'GDAL' paths to the environment and creates the variable global string variable gdalCmd, that contains the path to the 'GDAL' binaries.

Examples

run = FALSE
if (run) {
## example for the most common default OSGeo4W64 installation of GDAL
setenvGDAL(bin_GDAL = 'C:/OSGeo4W64/bin/',
          root_GDAL = 'C:/OSGeo4W64')
}

Usually for internally usage, create valid 'GRASS GIS 7.xx' rsession environment settings according to the selected GRASS GIS 7.x and Windows Version

Description

Initializes and set up access to 'GRASS GIS 7.xx' via the rgrass wrapper or command line packages. Set and returns all necessary environment variables and additionally returns the GISBASE directory as string.

Usage

setenvGRASSw(
  root_GRASS,
  grass_version = NULL,
  installation_type = NULL,
  quiet = TRUE
)

Arguments

Author(s)

Chris Reudenbach

Examples

## Not run: 
# set selected 'GRASS GIS' installation folders 
setenvGRASSw(root_GRASS = 'C:\\PROGRA~1\\QGIS2~1.18',
             grass_version =  'grass-7.2.1',
             installation_type =  'osgeo4W')

## End(Not run)

Setup project folder structure

Description

Defines folder structures and creates them if necessary, loads libraries, and sets other project relevant parameters.

Usage

setupProj(
  root_folder = tempdir(),
  folders = c("data", "data/tmp"),
  code_subfolder = NULL,
  global = FALSE,
  libs = NULL,
  setup_script = "000_setup.R",
  fcts_folder = NULL,
  source_functions = !is.null(fcts_folder),
  standard_setup = NULL,
  create_folders = TRUE
)

Arguments

Value

A list containing the project settings.

Examples

## Not run: 
setupProj(
  root_folder = '~/edu', folders = c('data/', 'data/tmp/'),
  libs = c('link2GI')
)

## End(Not run)

Define working environment default settings

Description

Define working environment default settings

Usage

setup_default(
  default = NULL,
  new_folder_list = NULL,
  new_folder_list_name = NULL
)

Arguments

Details

After adding new project settings run [setup_default()] to update and savew the default settings. For compatibility reasons you may also run [lutUpdate()].

Value

A list containing the default project settings

Examples

## Not run: 
# Standard setup for baseSpatial
setup_default()

## End(Not run)

Write sf object directly to 'GRASS' vector utilising an existing or creating a new GRASS environment

Description

Write sf object directly to 'GRASS' vector utilising an existing or creating a new GRASS environment

Usage

sf2gvec(x, epsg, obj_name, gisdbase, location, gisdbase_exist = FALSE)

Arguments

Note

have a look at the sf capabilities to write direct to sqlite

Author(s)

Chris Reudenbach

Examples

run = FALSE
if (run) {
## example 
require(sf)
require(sp)
require(link2GI)
data(meuse)
meuse_sf = st_as_sf(meuse, 
                    coords = c('x', 'y'), 
                    crs = 28992, 
                    agr = 'constant')


# write data to GRASS and create gisdbase
sf2gvec(x = meuse_sf,
        obj_name = 'meuse_R-G',
        gisdbase = '~/temp3/',
        location = 'project1')

# read from existing GRASS          
gvec2sf(x = meuse_sf,
        obj_name = 'meuse_r_g',
        gisdbase = '~/temp3',       
        location = 'project1')

}

Source functions from standard or given directory

Description

Source functions into the R environment located in a specified folder.

Usage

sourceFunctions(fcts_folder, setup_script)

Arguments

Value

Information if sourcing was successfull based on try function.

Examples

## Not run: 
# sourceFunctions(fcts_folder = '~/project/src/fcts')

## End(Not run)