poolEstimate: Pool AskCHIS NE Estimates

Description Usage Arguments Examples

Description

This function combines estimates for multiple geographic locations and is especially useful in combining multiple locations that might have suppressed estimates to get an overall estimate.

Usage

1
poolEstimate(indicator, attributes = NULL, locations, year = NULL, apiKey)

Arguments

indicator

The indicator id (can be obtained using getMetadata()) (required).

attributes

The specific attributes requested. A comma separated list that can include: estimate, population, SE, CI_L95, CI_U95, CV, MSE. Will return all if not specified (optional).

locations

The specific locations requested to be pooled. A comma separated list that must include geoIds (can be obtained from geoSearch()) (required).

year

The year of the data you request. Indicators and years available can be requested through the getMetadata() function. (optional).

apiKey

Your API key (required).

Examples

1
2
3
4
5
6
7
## Not run: 
poolEstimate(indicator = 'OBESEA', attributes = 'estimate,population', locations = '666000,644000',
year = NULL, apiKey = '<YOUR API KEY>')
# Returns a data frame with adult obesity estimates and populations for Los Angeles and
# San Diego cities COMBINED.

## End(Not run)

bogdanrau/askchisne documentation built on May 12, 2019, 11:31 p.m.