from_position {threewords}R Documentation

Resolve a Position to Three Identifying Words

Description

from_position takes latitude/longitude pair (or sequence of them) and resolves them to a word cluster used by what3words.

Usage

from_position(key, positions, ...)

Arguments

key

an API key obtained from what3words.

positions

either a vector containing a single latitude/longitude pair, or a list of vectors for vectorised operations.

...

further arguments to pass to httr's GET.

Value

A list containing the words, positions and language of those words.

See Also

from_position for the opposite operation.

Examples

## Not run: 
# Ask for a single set of words from the what3words API (note: this requires an API key.
# Don't actually use 'ANAPIKEY'.)
results <- from_position(key = "ANAPIKEY", positions = c(6.385336,-36.293769))

## End(Not run)

[Package threewords version 0.1.0 Index]