Man pages for Rnightlights
Satellite Nightlight Data Extraction

addCtryPolyIdxAdd an index column to all layers of a polygon
addREADMEAdd README file to the root data path
allValidCheck if a vector/list of values given is valid as per the...
allValidCtryAdmLvlsChecks if all ctry admLevels are valid
allValidCtryCodesCheck if all ctryCodes are valid
allValidNlPeriodsCheck if all nlPeriods are valid for given nlTypes
allValidNlTypesChecks if all given character strings are valid nlTypes
createCtryNlDataDFInitiates the country nightlight dataframe with the country...
createCtryStructSave ctry admin structure to text file for faster access
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 country names to ISO3 codes
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 admin level data file exists
existsCtryPolyChecks if a country polygon 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
fnAggRadRastCalculate statistics on a nightlight raster that fall within...
getAllGadmVersionsReturn a vector of GADM versions
getAllNlCtryCodesGet all known valid ISO3 country codes
getAllNlPeriodsGenerate a list of all possible nlPeriods for a given nlType
getAllNlTypesLists supported nightlight types
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
getCtryRasterOutputFnameConstructs the name of the output raster
getCtryRasterOutputFnamePathGet the full path to the file where the cropped VIIRS country...
getCtryShpAllAdmLvlsGet all the admLevels in a country
getCtryShpLowestLyrNamesGet the name of the lowest ctry admin level
getCtryShpLyrNamesGet the standard names of polygon layers in a country
getCtryStructAdmLevelNamesGet the list of admin level names in a polygon shapefile
getCtryStructFnameConstruct the name for the country struct file
getCtryStructFnamePathConstruct the full path to the country struct file
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...
getPolyFnameRDSGet the filename of the polygon zip file as downloaded from...
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
newNlTypeConvert pre-0.2.0 nlType names to their new names
nlCleanupClean up the environment after processing (Not yet...
nlInitInitialize some important variables and create directory...
nlRangeCreate a range of nlPeriods
orderCustPolyLayersOrder polygon shapefile layers in custom polygons
pkgOptionsSet or get options for the Rnightlights package
pkgResetReset global options for the Rnightlights package
plotCtryWithTilesVIIRSPlot a country boundary with the VIIRS tiles and world map
processNLCountryProcesses nightlights for an individual country in a...
processNlDataDownloads nightlight tiles and country polygons and calls the...
readCtryPolyAdmLayerRead a country admLevel polygon
readCtryStructReads the ctry admin structure from struct text file
removeDataPathDeletes a root data path all sub-directories
saveCtryNlDataSave a data frame of a country's data to the appropriate...
searchAdmLevelSearch for the admLevel by official name
searchCountrySearch for a country by name or code
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
upgradeRnightlightsPerform upgrade functions to new package versions as required
validCtryAdmLvlsChecks if ctry admLevels are valid
validCtryCodesCheck if country codes are valid
validCtryNlDataDFCheck if a country dataframe is valid
validGadmVersionsCheck whether GADM versions are valid
validNlPeriodsCheck if an nlPeriod is valid for a given nightlight type
validNlStatsCheck if given statistics are valid
validNlTileNameVIIRSCheck valid VIIRS nightlight tile name
validNlTileNumVIIRSCheck valid tile number for a given VIIRS nightlight type
validNlTypesChecks if a given character string is a valid nlType
ZonalPipeCreate a zonal file if it does not exist and calculate the...
Rnightlights documentation built on July 25, 2018, 1:05 a.m.