Rnightlights (version 0.1.2)

pkgOptions: Set or get options for the Rnightlights package

Description

Set or get options for the Rnightlights package

Usage

pkgOptions(...)

Arguments

...

Option names to retrieve option values or [key]=[value] pairs to set options.

Value

if an option name is supplied as a parameter this returns the value, else a list of all options is returned.

Supported options

The following options are supported

• dirNlTiles(character) The directory in which to store the downloaded VIIRS raster tiles

• dirRasterOutput(character) The directory in which to store the clipped country rasters

• dirRasterWeb(character) The directory in which to store the rasters resampled for web display

• dirZonals(character) The directory in which to store the zonal statistics country polygon

• dirPolygon(character) The directory to store the downloaded country administration level polygons

• dirNlData(character) The directory to store the extracted data files in

• cropMaskMethod(character) The method to use to clip the nightlight raster tiles to the country boundaries

• extractMethod(character) The method to use to extract data from the rasters

• downloadMethod(character) The download method to use

• omitCountries(character) The countries to exclude in processing

Examples

# NOT RUN {
#retrieve the current cropMaskMethod
pkgOptions("cropMaskMethod")

#set the cropMaskMethod
pkgOptions(cropMaskMethod="gdal")

#retrieve all options
pkgOptions()

# }