getCtryGFMaskOutputFnamePath: 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 mask 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
getCtryGFMaskOutputFnamePath(
  ctryCode,
  nlType,
  nlPeriod,
  gadmVersion = pkgOptions("gadmVersion"),
  gadmPolyType = pkgOptions("gadmPolyType"),
  custPolyPath = NULL
)

Arguments

ctryCode

(character) the ctryCode of interest

nlType

(character) the nlType of interest

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
## Not run: 
getCtryRasterOutputFnamePath("KEN","VIIRS.M", "201412")

## End(Not run)

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