getCtryRasterOutputFname: Constructs the name of the output raster

In chrisvwn/Rnightlights: Satellite Nightlight Data Extraction

Description

Constructs the name of the output raster

Usage

getCtryRasterOutputFname(
  ctryCode,
  nlType,
  configName = pkgOptions(paste0("configName_", nlType)),
  extension,
  multiTileStrategy = pkgOptions("multiTileStrategy"),
  multiTileMergeFun = pkgOptions("multiTileMergeFun"),
  removeGasFlaresMethod = pkgOptions(paste0("removeGasFlaresMethod_", nlType)),
  nlPeriod,
  gadmVersion = pkgOptions("gadmVersion"),
  gadmPolyType = pkgOptions("gadmPolyType"),
  custPolyPath = NULL
)

Arguments

ctryCode	the ctryCode of interest
nlType	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	logical Whether to perform gas flare removal pre-processing
nlPeriod	the nlPeriod of interest
gadmVersion	The GADM version to use
gadmPolyType	The format of polygons to download from GADM
custPolyPath	The path to a custom polygon as an alternative to using GADM polygons

Value

Character the name of country raster for a country and a given nlType and nlPeriod

Examples

Rnightlights:::getCtryRasterOutputFname(ctryCode = "KEN", nlType = "VIIRS.M", nlPeriod = "201412")

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