Learn R Programming

⚠️There's a newer version (0.2.4) of this package.Take me there.

Rnightlights (version 0.1.5)

Satellite Nightlight Data Extraction

Description

Extracts raster and zonal statistics from satellite nightlight rasters downloaded from the United States National Oceanic and Atmospheric Administration () free data repositories. Both the DMSP-OLS annual and SNPP-VIIRS monthly nightlight raster data are supported. Satellite nightlight raster tiles are downloaded and cropped to the country boundaries using shapefiles from the GADM database of Global Administrative Areas (). Zonal statistics are then calculated at the lowest administrative boundary for the selected country and cached locally for future retrieval. Finally, a simple data explorer/browser is included that allows one to visualize the cached data e.g. graphing, mapping and clustering regional data.

Copy Link

Version

Install

install.packages('Rnightlights')

Monthly Downloads

44

Version

0.1.5

License

GPL-3

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/chrisvwn/Rnightlights

Maintainer

Christopher Njuguna

Last Published

January 7th, 2018

Functions in Rnightlights (0.1.5)

Create a zonal file if it does not exist and calculate the zonal stats

Add README file to the root data path

getCtryNlDataColName

Construct the name of a nightlight data column given the nightlight type and nlPeriod

getCtryNlDataFname

Construct the name of the country data file.

getNlTileZipLclNamePath

Constructs the full path used to save/access the compressed downloaded tile

getNlTileZipLclNameVIIRS

Constructs the filename used to save/access the downloaded VIIRS tile .tgz file

Get the name of a tile given its index

mapCtryPolyToTilesVIIRS

Create a mapping of all countries and the tiles they intersect

Get the index of a tile given its name

Extract raster pixel values within the boundaries of a polygon

Deletes a root data path all sub-directories

Save a data frame of a country's data to the appropriate location

Check if a vector/list of values given is valid as per the given validation function

createCtryNlDataDF

Initiates the country nightlight dataframe with the country data read from the polygon

downloadNlTilesOLS

Download OLS nightlight tile

downloadNlTilesVIIRS

Download VIIRS nightlight tile

getCtryTileList

Returns a list of VIIRS nightlight tiles that a country or countries intersects with

Gets the root path to the file directory"

getPolyFnamePath

Get the path of the unzipped polygon directory downloaded from GADM.ORG

getPolyFnameZip

Get the filename of the polygon zip file as downloaded from http://www.GADM.ORG

List available data

listCtryNlRasters

List available cropped country rasters

Create a range of nlPeriods

Set or get options for the Rnightlights package

Sets the root path to the package data directory

Interactively allows the user to set up the default root path

Check if a statistic given is valid

Get the paths to the various data locations

getNlTifLclNameOLS

Constructs the filename used to save/access the decompressed OLS .tif file

Reset global options for the Rnightlights package

plotCtryWithTilesVIIRS

Plot a country polygon against a background of the VIIRS tiles and world map

Check if an nlPeriod is valid for a given nightlight type

validNlPeriodOLS

Check if an OLS nlYear is valid

createNlDataDirs

Create required data subdirectories in the root data path

createNlTilesSpPolysDF

Creates a tile Spatial Polygons DataFrame from the "nlTiles" dataframe

Download a country's polygon shapefile from http://gadm.org

downloadNlTiles

Download the listed tiles for a given nlType in a given nlPeriod

getAllNlPeriods

Generate a list of all possible nlPeriods for a given nlType

Returns nightlight statistics for the given ctryCode and nlType in the given nPeriods

getCtryShpLowestLyrName

Get the name of the lowest ctry admin level

getCtryShpLyrName

Get the standard name of a polygon layer for a country

getTilesCtryIntersectVIIRS

Get a list of tiles that a country polygon intersects with

insertNlDataCol

Insert an aggregate nightlight data column in a country nightlights dataframe

validCtryNlDataDF

Check if a country dataframe is valid

validNlMonthNum

Check if a month number is valid for a given nightlight type

Run a web application to explore the processed nightlight data cached locally

Calculate zonal statistics using GDAL. Faster than fnAggRadRast for large polygons.

Get the GADM url from which to download country polygons

getCtryRasterOutputFname

Get the full path to the file where the cropped VIIRS country raster is stored.

getNlTileTifLclNamePathOLS

Constructs the full path used to save/access the decompressed OLS .tif file

getNlTileTifLclNamePathVIIRS

Constructs the full path used to save/access the decompressed VIIRS .tif file

getNlTileTifLclNameVIIRS

Constructs the filename of the decompressed VIIRS .tif file

getNlTileZipLclNameOLS

The name with which to save the OLS tile locally

processNLCountry

Processes nightlights for an individual country in a particular nlPeriod

Downloads nightlight tiles and country polygons and calls the function to process them

validNlPeriodVIIRS

Check if a VIIRS nlYearMonth is valid

validNlTileNameVIIRS

Check if a tile index name is valid for a given nightlight type

getCtryNlDataFnamePath

Construct the full path to save the file containing the country data

extract data from a raster using one polygon in a multipolygon

getCtryPolyAdmLevelNames

Get the list of admin level names in a polygon shapefile

Calculate zonal statistics. Used internally

Clean up the environment after processing (Not yet implemented)

ctryShpLyrName2Num

Get the integer number of the layer.

deleteNlDataCol

Delete an aggregate nightlight data column in a country nightlights dataframe

existsPolyFnamePath

Check if the decompressed country polygon has been downloaded and stored in the polygon folder

existsPolyFnameZip

Check if the compressed country polygon has been downloaded and stored in the polygon folder

Calculate statistics on a nightlight raster that fall within a polygon

getAllNlCtryCodes

Check if a month number is valid for a given nightlight type

Initialize some important variables and create directory structure

getNlTileTifLclNameOLS

Constructs the filename of the decompressed OLS .tif file

getNlTileTifLclNamePath

Constructs the full path used to save/access the downloaded tile .tgz file

Function to return the url of the VIIRS tile to download

Returns the directory name of the unzipped shapefile downloaded from GADM.ORG without the path

List locally cached tiles

mapAllCtryPolyToTilesVIIRS

Create a mapping of all countries and the tiles they intersect

validNlTileNumVIIRS

Check if a tile index number is valid for a given nightlight type

Check if a year is valid for a given nightlight type

Convert a country ISO3 code to the full name

Convert a country name to its ISO3 code

existsCtryNlData

Check if VIIRS nightlight stats exist locally

existsCtryNlDataFile

Check if a country's data file exists

Create mapping of nightlight tiles

Function to return the url of the OLS tile to download

tilesPolygonIntersectVIIRS

Get the list of VIIRS tiles that a polygon intersects with

Check if a month number is valid for a given nightlight type