setPaths: Manage the internal paths of rasterTools

Description Usage Arguments Details Value Examples

Description

Manage the internal paths of rasterTools

Usage

1
setPaths(root = NULL, project = NULL, local = NULL, remote = NULL)

Arguments

root

[character(1)]
the root directory where all spatial files are already organised or should be saved to.

project

[character(1)]
the project directory where the output of various functions will be stored to.

local

[list(.)]
a named list pointing to the directory where the local resources are located.

remote

[list(.)]
a named list pointing to the url where the remote resources are located.

Details

When running the function setPaths the internal object rtPaths is update. In case root is given, this directory is searched for folders of all the specified datasets, and their path are assigned in rtPaths. With local or remote, the local or online directory of a specific dataset can be updated.

Value

Changes entries of the internal dataset rtPaths.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Not run: 

# run this when starting rasterTools for the first time
getOption("rtPaths")
setPaths(root = "/path/to/the/spatial/files")

# in case a dataset is at an exotic locations
setPaths(local = list(sentinel = "/path/outside/of/root"))

# change the (outdated) url of some datasets
setPaths(remote = list(sentinel = "https://new_url_to_sentinel/")

getOption("rtPaths")

## End(Not run)

EhrmannS/rasterTools documentation built on May 28, 2019, 8:24 a.m.