listRaster: List all MAP Rasters available to download.

In malariaAtlas: An R Interface to Open-Access Malaria Data, Hosted by the 'Malaria Atlas Project'

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. dataset_id the unique dataset ID of the raster, which can the be used in functions such as getRaster and extractRaster

2. raster_code unique identifier for each raster

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

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

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

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

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

8. min_raster_year earliest year for which each raster is available

9. max_raster_year latest year for which each raster is available

Examples

## Not run: 
available_rasters <- listRaster()

## End(Not run)

malariaAtlas documentation built on Oct. 27, 2023, 9:07 a.m.