set_env: Retrieve the environment settings to run QGIS from within R

Description Usage Arguments Value Author(s) Examples

Description

set_env tries to find all the paths necessary to run QGIS from within R.

Usage

1
set_env(root = NULL, ltr = TRUE)

Arguments

root

Root path to the QGIS-installation. If left empty, the function looks for qgis.bat on the C: drive under Windows. On a Mac, it looks for QGIS.app under "Applications" and "/usr/local/Cellar/". On Linux, set_env assumes that the root path is "/usr".

ltr

If TRUE, set_env will use the long term release of QGIS, if available (only for Windows).

Value

The function returns a list containing all the path necessary to run QGIS from within R. This is the root path, the QGIS prefix path and the path to the Python plugins.

Author(s)

Jannes Muenchow, Patrick Schratz

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# Letting set_env look for the QGIS installation might take a while depending
# on how full the C: drive is (Windows)
set_env()
# It is much faster (0 sec) to explicitly state the root path to the QGIS 
# installation
set_env("C:/OSGEO4~1")  # Windows example

## End(Not run)


Search within the RQGIS package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.