indicator: Return HarvestChoice indicator metadata

In harvestchoice/hc-api3: HarvestChoice Data Services v3

Description

Return complete metadata records for selected HarvestChoice indicators.

Usage

indicator(q, version = NULL, as.class = "data.table", cartoCSS = FALSE)

Arguments

q	character array of pattern(s) to search against HarvestChoice indicator codes, labels, and categories. Will attempt a fuzzy match.
version	optional version filter
as.class	"data.table" (default) or "list" for a list of indicators grouped by category
cartoCSS	also include formatted CartoCSS rules

Details

# API call: metadata records for all indicators matching 'cassava' or 'population'

$ curl http://hcapi.harvestchoice.org/ocpu/library/hcapi3/R/indicator/json \ -d '{"q" : ["cassava", "population"]}' \ -X POST -H "Content-Type:application/json"

API call: metadata records for all indicators matching 'population' in a list

$ curl http://hcapi.harvestchoice.org/ocpu/library/hcapi3/R/indicator/json \ -d '{"q" : "population", "as.class" : "list"}' \ -X POST -H "Content-Type:application/json"

Value

a data.table or hierarchical list of indicator metadata

See Also

category to view HarvestChoice indicator categories

Examples

# Show complete metadata for all HarvestChoice indicators matching 'cassava' or
'population'
indicator(c("cassava", "population"))

# Show complete metadata for all HarvestChoice indicators matching 'population'
# in a hierarchical list
indicator("population", as.class="list")[1:2]

harvestchoice/hc-api3 documentation built on May 17, 2019, 3:04 p.m.