getCtryRasterOutputFnamePath: Get the full path to the file where the cropped VIIRS country...

Description Usage Arguments Value Examples

View source: R/nightlights.R

Description

Get the full path to the file where the cropped VIIRS country raster is stored. This file is created when processing the country before extracting the data. It can be used to re-process a country much faster

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
getCtryRasterOutputFnamePath(
  ctryCode,
  nlType,
  configName,
  extension,
  multiTileStrategy = pkgOptions("multiTileStrategy"),
  multiTileMergeFun = pkgOptions("multiTileMergeFun"),
  removeGasFlaresMethod = pkgOptions(paste0("removeGasFlaresMethod_", nlType)),
  nlPeriod,
  gadmVersion = pkgOptions("gadmVersion"),
  gadmPolyType = pkgOptions("gadmPolyType"),
  custPolyPath = NULL
)

Arguments

ctryCode

(character) the ctryCode of interest

nlType

(character) the nlType of interest

configName

character the config shortname of raster being processed

extension

character the extension of raster being processed

multiTileStrategy

(character) How to handle multiple tiles per nlPeriod

multiTileMergeFun

(character) The function to use to merge tiles

removeGasFlaresMethod

(character) The method to use to perform gas flare removal

nlPeriod

(character) the nlPeriod of interest

gadmVersion

(character) The GADM version to use

gadmPolyType

(character) The format of polygons to download from GADM

custPolyPath

(character) The path to a custom polygon as an alternative to using GADM polygons

Value

(character) full path to the cropped VIIRS country raster for a country and a given year and month

Examples

1
2
3
4
5
6
## Not run: 
getCtryRasterOutputFnamePath("KEN","VIIRS.M", "201412")

## End(Not run)

#export for gui() shiny app

chrisvwn/Rnightlights documentation built on Sept. 7, 2021, 1:44 a.m.