search_census_vectors: Query the CensusMapper API for vectors with descriptions...

Description Usage Arguments Examples

View source: R/cancensus.R

Description

Query the CensusMapper API for vectors with descriptions matching a searchterm.

Usage

1
search_census_vectors(searchterm, dataset, type = NA, ...)

Arguments

searchterm

The term to search for e.g. "Ojibway". Search terms are case insensitive. If unable to find a given search term, this function will suggest the correct spelling to use when possible.

dataset

The dataset to query for available vectors, e.g. "CA16".

type

One of NA, 'Total', 'Male' or 'Female'. If specified, only return variables of specified 'type'.

...

Further arguments passed on to list_census_vectors.

Examples

1
2
3
4
5
6
search_census_vectors('Ojibway', 'CA16')
## Not run: 
# This will return a warning that no match was found, but will suggest similar terms.
search_census_vectors('Ojibwe', 'CA16', 'Total')

## End(Not run)

cancensus documentation built on Feb. 4, 2018, 5:02 p.m.