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

View source: R/vector_discovery.R

search_census_vectorsR Documentation

Query the CensusMapper API for vectors with descriptions matching a search term or phrase (deprecated)

Description

Query the CensusMapper API for vectors with descriptions matching a search term or phrase (deprecated)

Usage

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

Arguments

searchterm

The term or phrase to search for e.g. "Ojibway". Search terms are case insensitive. If unable to find a given string, this function will suggest similarly named objects.

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

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 May 29, 2024, 6:21 a.m.