plotKML.env {plotKML}R Documentation

plotKML specific environmental variables / paths

Description

Sets the environmental, package specific parameters and settings (URLs, names, default color palettes and similar) that can be later on passed to other functions.

Usage

plotKML.env(colour_scale_numeric = "", colour_scale_factor = "",
        colour_scale_svar = "", ref_CRS, NAflag, icon, LabelScale, size_range, 
        license_url, metadata_sel, kmz, kml_xsd, kml_url, kml_gx, gpx_xsd,
        fgdc_xsd, inspire_xsd, convert, gdalwarp, gdal_translate, python,
        home_url, show.env = TRUE, silent = TRUE)

Arguments

colour_scale_numeric

default colour scheme for numeric variables

colour_scale_factor

default colour scheme for factor variables

colour_scale_svar

default colour scheme for model error (e.g. mapping error)

ref_CRS

the referent CRS proj4string ("+proj=longlat +datum=WGS84")

NAflag

the default missing value flag (usually "-99999")

icon

the default icon URL

LabelScale

the default scale factor for labels

size_range

the default size range

license_url

the default license URL

metadata_sel

a list of the default metadata fields for summary

kmz

logical; the default compression setting

kml_xsd

the default KML scheme URL

kml_url

the default KML format URL

kml_gx

the default extended KML scheme URL

gpx_xsd

the default GPX scheme URL

fgdc_xsd

the default metadata scheme URL

inspire_xsd

the default metadata scheme URL

convert

a path to ImageMagick convert program

gdalwarp

a path to gdalwarp program

gdal_translate

a path to gdalwarp program

python

a path to Python program

home_url

the default location of all icons and auxiliary files

show.env

logical; specify whether to print all environmental parameters

silent

logical; specify whether to search for paths for external software

Details

The function will try to locate external software tools under either Windows or Unix platform and then save the results to the plotKML.opts environment. plotKML-package does not look automatically for software paths (unless you specify this manually in your "Rprofile.site").
The external software tools are not required by default and most of operations in plotKML-package can be run without using them. GDAL, SAGA GIS and Python are highly recommended, however, for processing large data sets. The function paths looks for GDAL, ImageMagick, Python, SAGA GIS, in the Windows Registry Hive, the Program Files directory or the usr/bin installation (Unix).

Warning

Under Linux OS you need to install GDAL binaries by using:
sudo apt-get install gdal-bin

Note

To further customize the plotKML options, consider putting:
library(plotKML); plotKML.env(..., show.env = FALSE)
in your "/etc/Rprofile.site".

Author(s)

Tomislav Hengl, Dylan Beaudette

References

Examples

## Not run: ## look for paths:
library(gdalUtils)
pts <- paths()
pts
plotKML.env(silent = FALSE)
gdalwarp <- get("gdalwarp", envir = plotKML.opts)
## if missing you need to install it!
system(paste(gdalwarp, "--help-general")) 
system(paste(gdalwarp, "--formats"), intern = TRUE)

## End(Not run)
plotKML.env(show.env = FALSE)
get("home_url", envir = plotKML.opts)

[Package plotKML version 0.5-6 Index]