A C D E F G I L M N O P R S T U V Z
addCtryPolyIdx | Add an index column to all layers of a polygon |
addREADME | Add README file to the root data path |
allValid | Check if a vector/list of values given is valid as per the given validation function |
allValidCtryAdmLvls | Checks if all ctry admLevels are valid |
allValidCtryCodes | Check if all ctryCodes are valid |
allValidNlPeriods | Check if all nlPeriods are valid for given nlTypes |
allValidNlTypes | Checks if all given character strings are valid nlTypes |
createCtryNlDataDF | Initiates the country nightlight dataframe with the country admin level data read from the polygon |
createCtryStruct | Save ctry admin structure to text file for faster access |
createNlDataDirs | Create required data subdirectories in the root data path |
createNlTilesSpPolysDF | Creates a tile Spatial Polygons DataFrame from the '"nlTiles"' dataframe |
ctryCodeToName | Convert a country ISO3 code to the full name |
ctryNameToCode | Convert country names to ISO3 codes |
ctryShpLyrName2Num | Get the integer number of the layer. |
deleteNlDataCol | Delete an aggregate nightlight data column in a country nightlights dataframe |
dnldCtryPoly | Download a country's polygon shapefile from <URL: http://gadm.org> |
downloadNlTiles | Download the listed tiles for a given nlType in a given nlPeriod |
downloadNlTilesOLS | Download OLS nightlight tile |
downloadNlTilesVIIRS | Download VIIRS nightlight tile |
existsCtryNlData | Check if VIIRS nightlight stats exist locally |
existsCtryNlDataFile | Check if a country admin level data file exists |
existsCtryPoly | Checks if a country polygon exists |
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 |
exploreData | Run a web application to explore the processed nightlight data cached locally |
fnAggRadGdal | Calculate zonal statistics using GDAL |
fnAggRadRast | Calculate statistics on a nightlight raster that fall within a polygon |
getAllGadmVersions | Return a vector of GADM versions |
getAllNlCtryCodes | Get all known valid ISO3 country codes |
getAllNlPeriods | Generate a list of all possible nlPeriods for a given nlType |
getAllNlTypes | Lists supported nightlight types |
getCtryNlData | Returns nightlight statistics for the given ctryCode and nlType in the given nPeriods |
getCtryNlDataColName | Construct the name of a nightlight data column given the nightlight type and nlPeriod |
getCtryNlDataFname | Construct the name of the country data file. |
getCtryNlDataFnamePath | Construct the full path to save the file containing the country data |
getCtryPolyAdmLevelNames | Get the list of admin level names in a polygon shapefile |
getCtryPolyUrl | Get the GADM url from which to download country polygons |
getCtryRasterOutputFname | Constructs the name of the output raster |
getCtryRasterOutputFnamePath | Get the full path to the file where the cropped VIIRS country raster is stored. |
getCtryShpAllAdmLvls | Get all the admLevels in a country |
getCtryShpLowestLyrNames | Get the name of the lowest ctry admin level |
getCtryShpLyrNames | Get the standard names of polygon layers in a country |
getCtryStructAdmLevelNames | Get the list of admin level names in a polygon shapefile |
getCtryStructFname | Construct the name for the country struct file |
getCtryStructFnamePath | Construct the full path to the country struct file |
getCtryTileList | Returns a list of VIIRS nightlight tiles that a country or countries intersects with |
getNlDataPath | Gets the root path to the file directory" |
getNlDir | Get the paths to the various data locations |
getNlTifLclNameOLS | Constructs the filename used to save/access the decompressed OLS .tif file |
getNlTiles | Create mapping of nightlight tiles |
getNlTileTifLclNameOLS | Constructs the filename of the decompressed OLS .tif file |
getNlTileTifLclNamePath | Constructs the full path used to save/access the downloaded tile .tgz file |
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 |
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 |
getNlUrlOLS | Function to return the url of the OLS tile to download |
getNlUrlVIIRS | Function to return the url of the VIIRS tile to download |
getPolyFname | Returns the directory name of the unzipped shapefile downloaded from http://gadm.org without the path |
getPolyFnamePath | Get the path of the unzipped polygon directory downloaded from GADM.ORG |
getPolyFnameRDS | Get the filename of the polygon zip file as downloaded from <URL: http://GADM.ORG> |
getPolyFnameZip | Get the filename of the polygon zip file as downloaded from <URL: http://GADM.ORG> |
getTilesCtryIntersectVIIRS | Get a list of tiles that a country polygon intersects with |
insertNlDataCol | Insert an aggregate nightlight data column in a country nightlights dataframe |
listCtryNlData | List available data |
listCtryNlRasters | List available cropped country rasters |
listNlTiles | List locally cached tiles |
mapAllCtryPolyToTilesVIIRS | Create a mapping of all countries and the tiles they intersect |
mapCtryPolyToTilesVIIRS | Create a mapping of all countries and the tiles they intersect |
masqOLS | Extract raster pixel values within the boundaries of a polygon |
masqVIIRS | extract data from a raster using one polygon in a multipolygon |
myZonal | Calculate zonal statistics. Used internally |
newNlType | Convert pre-0.2.0 nlType names to their new names |
nlCleanup | Clean up the environment after processing (Not yet implemented) |
nlInit | Initialize some important variables and create directory structure |
nlRange | Create a range of nlPeriods |
orderCustPolyLayers | Order polygon shapefile layers in custom polygons |
pkgOptions | Set or get options for the Rnightlights package |
pkgReset | Reset global options for the Rnightlights package |
plotCtryWithTilesVIIRS | Plot a country boundary with the VIIRS tiles and world map |
processNLCountry | Processes nightlights for an individual country in a particular nlPeriod |
processNlData | Downloads nightlight tiles and country polygons and calls the function to process them |
readCtryPolyAdmLayer | Read a country admLevel polygon |
readCtryStruct | Reads the ctry admin structure from struct text file |
removeDataPath | Deletes a root data path all sub-directories |
saveCtryNlData | Save a data frame of a country's data to the appropriate location |
searchAdmLevel | Search for the admLevel by official name |
searchCountry | Search for a country by name or code |
setNlDataPath | Sets the root path to the package data directory |
setupDataPath | Interactively allows the user to set up the default root path |
tileIdx2Name | Get the name of a tile given its index |
tileName2Idx | Get the index of a tile given its name |
tilesPolygonIntersectVIIRS | Get the list of VIIRS tiles that a polygon intersects with |
upgradeRnightlights | Perform upgrade functions to new package versions as required |
validCtryAdmLvls | Checks if ctry admLevels are valid |
validCtryCodes | Check if country codes are valid |
validCtryNlDataDF | Check if a country dataframe is valid |
validGadmVersions | Check whether GADM versions are valid |
validNlPeriods | Check if an nlPeriod is valid for a given nightlight type |
validNlStats | Check if given statistics are valid |
validNlTileNameVIIRS | Check valid VIIRS nightlight tile name |
validNlTileNumVIIRS | Check valid tile number for a given VIIRS nightlight type |
validNlTypes | Checks if a given character string is a valid nlType |
ZonalPipe | Create a zonal file if it does not exist and calculate the zonal stats |