searchAdmLevelName: Search for the admLevelName

In chrisvwn/Rnightlights: Satellite Nightlight Data Extraction

Description

Search for the admLevelName by official name. Expects the shapefile to already exist.

Usage

searchAdmLevelName(
  ctryCodes = NULL,
  admLevelNames,
  dnldPoly = TRUE,
  downloadMethod = pkgOptions("downloadMethod"),
  gadmVersion = pkgOptions("gadmVersion"),
  gadmPolyType = pkgOptions("gadmPolyType"),
  custPolyPath = NULL
)

Arguments

ctryCodes	character The ctryCodes of the country of interest
admLevelNames	character The names to search for
dnldPoly	logical If the country polygon doesn't exist should we download it?
downloadMethod	The method used to download polygons
gadmVersion	The GADM version to use
gadmPolyType	The format of polygons to download from GADM
custPolyPath	Alternative to GADM. A path to a custom shapefile zip

Value

character vector of admin level names

Examples

## Not run: 
searchAdmLevelName("KEN", "county")
#returns "county"

## End(Not run)

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