![[R logo]](../../../doc/html/logo.jpg){kind=logo}
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
| 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 |
| createCtryNlDataDF | Initiates the country nightlight dataframe with the country data read from the polygon |
| 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 a country name to its ISO3 code |
| 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's data file 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. Faster than fnAggRadRast for large polygons. |
| fnAggRadRast | Calculate statistics on a nightlight raster that fall within a polygon |
| getAllNlCtryCodes | Check if a month number is valid for a given nightlight type |
| getAllNlPeriods | Generate a list of all possible nlPeriods for a given nlType |
| 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 | Get the full path to the file where the cropped VIIRS country raster is stored. |
| getCtryShpLowestLyrName | Get the name of the lowest ctry admin level |
| getCtryShpLyrName | Get the standard name of a polygon layer for a country |
| 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 GADM.ORG without the path |
| 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 <URL: http://www.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 |
| 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 |
| pkgOptions | Set or get options for the Rnightlights package |
| pkgReset | Reset global options for the Rnightlights package |
| plotCtryWithTilesVIIRS | Plot a country polygon against a background of 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 |
| removeDataPath | Deletes a root data path all sub-directories |
| saveCtryNlData | Save a data frame of a country's data to the appropriate location |
| 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 |
| validCtryCode | Check if a month number is valid for a given nightlight type |
| validCtryNlDataDF | Check if a country dataframe is valid |
| validNlMonthNum | Check if a month number is valid for a given nightlight type |
| validNlPeriod | Check if an nlPeriod is valid for a given nightlight type |
| validNlPeriodOLS | Check if an OLS nlYear is valid |
| validNlPeriodVIIRS | Check if a VIIRS nlYearMonth is valid |
| validNlTileNameVIIRS | Check if a tile index name is valid for a given nightlight type |
| validNlTileNumVIIRS | Check if a tile index number is valid for a given nightlight type |
| validNlYearNum | Check if a year is valid for a given nightlight type |
| validStat | Check if a statistic given is valid |
| ZonalPipe | Create a zonal file if it does not exist and calculate the zonal stats |