listCtryNlData: List available data

In chrisvwn/Rnightlights: Satellite Nightlight Data Extraction

Description

List available data. If source is "local" it lists data cached locally. If source is remote lists available data on the remote repository.

Usage

listCtryNlData(
  ctryCodes = NULL,
  admLevels = NULL,
  nlTypes = NULL,
  configNames = NULL,
  extensions = NULL,
  multiTileMergeStrategys = NULL,
  multiTileMergeFuns = NULL,
  removeGasFlaresMethod = NULL,
  nlPeriods = NULL,
  polySrcs = NULL,
  polyVers = NULL,
  polyTypes = NULL,
  nlStats = NULL,
  source = "local"
)

Arguments

ctryCodes	character vector of ctryCodes to filter by
admLevels	A character vector of admLevels to filter by
nlTypes	A character vector of nlTypes to filter by
configNames	character the config shortnames of rasters to filter by
extensions	character the extensions of rasters to filter by
multiTileMergeStrategys	character the multiTileMergeStrategies to filter by
multiTileMergeFuns	character the multiTileMergeFuns to filter by
removeGasFlaresMethod	character filter by removeGasFlare values
nlPeriods	A character vector of nlPeriods to filter by
polySrcs	The source of polygons e.g. GADM or CUST to filter by
polyVers	The version of the polygon source to filter by
polyTypes	The format of polygons to download from GADM
nlStats	The stats to filter by
source	Character string. Whether to check data availability "local" or "remote" Not in use.

Value

a list of countries and the periods and stats for each

Examples

#list all data
listCtryNlData()

#list all data available for KEN
listCtryNlData(ctryCodes = "KEN")

#list all VIIRS.* data available for ECU
listCtryNlData(ctryCodes = "ECU", nlTypes = "VIIRS")

#list available OLS.Y data for KEN and RWA in 2012 & 2013
listCtryNlData(ctryCodes = c("KEN","RWA"), nlPeriods = c("2012", "2013"), nlTypes = "OLS.Y")

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