R/words.R

Defines functions from_words single_words

Documented in from_words

single_words <- function(words, key, ...){
  url <- paste0("https://api.what3words.com/w3w?key=", key,
                "&string=", paste(words, collapse = "."))
 return(clean(threeword_query(url, ...)))
}

#'@title Resolve Three Identifying Words to a Position
#'@description \code{from_words} takes a word cluster used by what3words and
#'converts them back into latitude/longitude pairs.
#'
#'@param key an API key obtained from \href{http://developer.what3words.com/}{what3words}.
#'
#'@param words either a vector of words, for a single latitude/longitude pair, or a \emph{list} of vectors
#'for vectorised operations.
#'
#'@param ... further arguments to pass to httr's GET.
#'
#'@return A list containing the words, positions and language of those words.
#'
#'@seealso
#'\code{\link{from_position}} for the opposite operation.
#'
#'@examples
#'\dontrun{
#'# Ask for a single lat/long pair from the what3words API (note: this requires an API key.
#'# Don't actually use 'ANAPIKEY'.)
#'results <- from_words(key = "ANAPIKEY", words = c("turnip","basil","fruit"))
#'}
#'@export
from_words <- function(key, words, ...){
  if(is.list(words)){
    return(lapply(words, single_words, key, ...))
  }
  return(single_words(words, key, ...))
}

Try the threewords package in your browser

Any scripts or data that you put into this service are public.

threewords documentation built on May 29, 2017, 10:56 a.m.