listCtryNlRasters: List available cropped country rasters

Description Usage Arguments Value Examples

View source: R/ctrynldata.R

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
listCtryNlRasters(
  ctryCodes = NULL,
  nlPeriods = NULL,
  nlTypes = NULL,
  configNames = NULL,
  extensions = NULL,
  polySrcs = NULL,
  polyVers = NULL,
  nlStats = NULL,
  source = "local"
)

Arguments

ctryCodes

A character vector of ctryCodes to filter by

nlPeriods

A character vector of nlPeriods 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

polySrcs

The source of polygons e.g. GADM or CUST to filter by

polyVers

The version of the polygon source to filter by

nlStats

The stats to filter by

source

Character string. Whether to check data availability "local" or "remote". Default is "local".

Value

a list of existing cropped rasters

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#list all rasters
listCtryNlRasters()

#list all rasters available for KEN
listCtryNlRasters(ctryCodes = "KEN")

#list all VIIRS rasters available for ECU
listCtryNlRasters(ctryCodes = "ECU", nlTypes = "VIIRS")

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

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