getCtryNlDataFname: Construct the name of the country data file.
In Rnightlights: Satellite Nightlight Data Extraction
Description
Usage
Arguments
Value
Examples
Description
Construct the name of the data file. This function can be altered to name the file as
required and consistently retrieve the name. Used in the function getCtryNlDataFnamePath
to concat the directory path and this filename. Currently all nlTypes are stored in one
file. Can be altered to separate VIIRS and OLS data files for example.
Usage
1
2
3
getCtryNlDataFname(ctryCode = NULL, admLevel,
gadmVersion = pkgOptions("gadmVersion"),
gadmPolyType = pkgOptions("gadmPolyType"), custPolyPath = NULL)
Arguments
ctryCode
The ctryCode of interest
admLevel
The country admin level of interest
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 filename of the country data file
Examples
1
2
3
4
ctryCode <- "KEN"
admLevel <- "KEN_adm0"
Rnightlights:::getCtryNlDataFname(ctryCode, admLevel)
#returns string of name of the ctry data file
Rnightlights documentation built on Aug. 29, 2019, 5:02 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
Description
Construct the name of the data file. This function can be altered to name the file as required and consistently retrieve the name. Used in the function getCtryNlDataFnamePath to concat the directory path and this filename. Currently all nlTypes are stored in one file. Can be altered to separate VIIRS and OLS data files for example.
Usage
1 2 3 | getCtryNlDataFname(ctryCode = NULL, admLevel,
gadmVersion = pkgOptions("gadmVersion"),
gadmPolyType = pkgOptions("gadmPolyType"), custPolyPath = NULL)
|
Arguments
ctryCode |
The ctryCode of interest |
admLevel |
The country admin level of interest |
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 filename of the country data file
Examples
1 2 3 4 | ctryCode <- "KEN"
admLevel <- "KEN_adm0"
Rnightlights:::getCtryNlDataFname(ctryCode, admLevel)
#returns string of name of the ctry data file
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.