isAvailable_pr: Check whether PR points are available for a given location

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

Check whether PR points are available for a given location

Description

isAvailable_pr checks whether the MAP database contains PR points for the specified country/location.

Usage

isAvailable_pr(
  sourcedata = NULL,
  country = NULL,
  ISO = NULL,
  continent = NULL,
  full_results = FALSE,
  version = NULL
)

Arguments

sourcedata	deprecated argument. Please remove it from your code.
country	string containing name of desired country, e.g. c("Country1", "Country2", ...) (use one of country OR ISO OR continent, not combined)
ISO	string containing ISO3 code for desired country, e.g. c("XXX", "YYY", ...) (use one of country OR ISO OR continent, not combined)
continent	string containing name of continent for desired data, e.g. c("Continent1", "Continent2", ...)(use one of country OR ISO OR continent, not combined)
full_results	By default this is FALSE meaning the function only gives a message outlining whether specified country is available, if full_results == TRUE, the function returns a named list outlining data availability.
version	(optional) The PR dataset version to use. If not provided, will just use the most recent version of PR data. (To see available version options, use listPRPointVersions)

Value

isAvailable_pr returns a named list of input locations with information regarding data availability.

if full_results == TRUE, a named list is returned with the following elements:

1. location - specified input locations

2. is_available- 1 or 0; indicating whether data is available for this location

3. possible_match- agrep-matched country names indicating potential mispellings of countries where is_available == 0; NA if data is available for this location.

Examples

## Not run: 
isAvailable_pr(country = "Suriname")
x <- isAvailable_pr(ISO = "NGA", full_results = TRUE)
x <- isAvailable_pr(continent = "Oceania", full_results = TRUE)

## End(Not run)

malaria-atlas-project/malariaAtlas documentation built on Nov. 5, 2023, 2:03 p.m.