malariaAtlas (version 0.0.5)

listRaster: List all MAP Rasters available to download.

Description

listRaster lists all rasters available to download from the Malaria Atlas Project database.

Usage

listRaster(printed = TRUE)

Arguments

printed

Should the list be printed to the console?

Value

listRaster returns a data.frame detailing the following information for each raster available to download from the Malaria Atlas Project database.

1. raster_code unique identifier for each raster

2. title abbreviated title for each raster, used as surface argument in getRaster()

3. title_extended extended title for each raster, detailing raster content

4. abstract full description of each raster, outlining raster creation methods, raster content and more.

5. citation citation of peer-reviewed article in which each raster has been published

6. pub_year year in which raster was published, used as pub_year argument in getRaster() to updated raster versions from their predecessor(s).

7. min_raster_year earliest year for which each raster is available

8. max_raster_year latest year for which each raster is available

Examples

# NOT RUN {
available_rasters <- listRaster()
# }