Man pages for Rnightlights
Satellite Nightlight Data Extraction

addREADMEAdd README file to the root data path
allValidCheck if a vector/list of values given is valid as per the...
createCtryNlDataDFInitiates the country nightlight dataframe with the country...
createNlDataDirsCreate required data subdirectories in the root data path
createNlTilesSpPolysDFCreates a tile Spatial Polygons DataFrame from the...
ctryCodeToNameConvert a country ISO3 code to the full name
ctryNameToCodeConvert a country name to its ISO3 code
ctryShpLyrName2NumGet the integer number of the layer.
deleteNlDataColDelete an aggregate nightlight data column in a country...
dnldCtryPolyDownload a country's polygon shapefile from <URL:...
downloadNlTilesDownload the listed tiles for a given nlType in a given...
downloadNlTilesOLSDownload OLS nightlight tile
downloadNlTilesVIIRSDownload VIIRS nightlight tile
existsCtryNlDataCheck if VIIRS nightlight stats exist locally
existsCtryNlDataFileCheck if a country's data file exists
existsPolyFnamePathCheck if the decompressed country polygon has been downloaded...
existsPolyFnameZipCheck if the compressed country polygon has been downloaded...
exploreDataRun a web application to explore the processed nightlight...
fnAggRadGdalCalculate zonal statistics using GDAL. Faster than...
fnAggRadRastCalculate statistics on a nightlight raster that fall within...
getAllNlCtryCodesCheck if a month number is valid for a given nightlight type
getAllNlPeriodsGenerate a list of all possible nlPeriods for a given nlType
getCtryNlDataReturns nightlight statistics for the given ctryCode and...
getCtryNlDataColNameConstruct the name of a nightlight data column given the...
getCtryNlDataFnameConstruct the name of the country data file.
getCtryNlDataFnamePathConstruct the full path to save the file containing the...
getCtryPolyAdmLevelNamesGet the list of admin level names in a polygon shapefile
getCtryPolyUrlGet the GADM url from which to download country polygons
getCtryRasterOutputFnameGet the full path to the file where the cropped VIIRS country...
getCtryShpLowestLyrNameGet the name of the lowest ctry admin level
getCtryShpLyrNameGet the standard name of a polygon layer for a country
getCtryTileListReturns a list of VIIRS nightlight tiles that a country or...
getNlDataPathGets the root path to the file directory"
getNlDirGet the paths to the various data locations
getNlTifLclNameOLSConstructs the filename used to save/access the decompressed...
getNlTilesCreate mapping of nightlight tiles
getNlTileTifLclNameOLSConstructs the filename of the decompressed OLS .tif file
getNlTileTifLclNamePathConstructs the full path used to save/access the downloaded...
getNlTileTifLclNamePathOLSConstructs the full path used to save/access the decompressed...
getNlTileTifLclNamePathVIIRSConstructs the full path used to save/access the decompressed...
getNlTileTifLclNameVIIRSConstructs the filename of the decompressed VIIRS .tif file
getNlTileZipLclNameOLSThe name with which to save the OLS tile locally
getNlTileZipLclNamePathConstructs the full path used to save/access the compressed...
getNlTileZipLclNameVIIRSConstructs the filename used to save/access the downloaded...
getNlUrlOLSFunction to return the url of the OLS tile to download
getNlUrlVIIRSFunction to return the url of the VIIRS tile to download
getPolyFnameReturns the directory name of the unzipped shapefile...
getPolyFnamePathGet the path of the unzipped polygon directory downloaded...
getPolyFnameZipGet the filename of the polygon zip file as downloaded from...
getTilesCtryIntersectVIIRSGet a list of tiles that a country polygon intersects with
insertNlDataColInsert an aggregate nightlight data column in a country...
listCtryNlDataList available data
listCtryNlRastersList available cropped country rasters
listNlTilesList locally cached tiles
mapAllCtryPolyToTilesVIIRSCreate a mapping of all countries and the tiles they...
mapCtryPolyToTilesVIIRSCreate a mapping of all countries and the tiles they...
masqOLSExtract raster pixel values within the boundaries of a...
masqVIIRSextract data from a raster using one polygon in a...
myZonalCalculate zonal statistics. Used internally
nlCleanupClean up the environment after processing (Not yet...
nlInitInitialize some important variables and create directory...
nlRangeCreate a range of nlPeriods
pkgOptionsSet or get options for the Rnightlights package
pkgResetReset global options for the Rnightlights package
plotCtryWithTilesVIIRSPlot a country polygon against a background of the VIIRS...
processNLCountryProcesses nightlights for an individual country in a...
processNlDataDownloads nightlight tiles and country polygons and calls the...
removeDataPathDeletes a root data path all sub-directories
saveCtryNlDataSave a data frame of a country's data to the appropriate...
setNlDataPathSets the root path to the package data directory
setupDataPathInteractively allows the user to set up the default root path
tileIdx2NameGet the name of a tile given its index
tileName2IdxGet the index of a tile given its name
tilesPolygonIntersectVIIRSGet the list of VIIRS tiles that a polygon intersects with
validCtryCodeCheck if a month number is valid for a given nightlight type
validCtryNlDataDFCheck if a country dataframe is valid
validNlMonthNumCheck if a month number is valid for a given nightlight type
validNlPeriodCheck if an nlPeriod is valid for a given nightlight type
validNlPeriodOLSCheck if an OLS nlYear is valid
validNlPeriodVIIRSCheck if a VIIRS nlYearMonth is valid
validNlTileNameVIIRSCheck if a tile index name is valid for a given nightlight...
validNlTileNumVIIRSCheck if a tile index number is valid for a given nightlight...
validNlYearNumCheck if a year is valid for a given nightlight type
validStatCheck if a statistic given is valid
ZonalPipeCreate a zonal file if it does not exist and calculate the...
Rnightlights documentation built on Jan. 8, 2018, 1:03 a.m.