find_locations: Find Breweries By Location

Description Usage Arguments Value

View source: R/find_locations.R

Description

Find Breweries By Location

Usage

1
2
find_locations(api_key, locality = NULL, region = NULL,
  postal_code = NULL, status = "verified", data_frame = TRUE)

Arguments

api_key

a charater string containing a BreweryDB API key. See http://www.brewerydb.com/developers to obtain an API key.

locality

a character string indicating the location of the breweries. In the US this corespods to a city.

region

a character string indicating the location of the breweries. In the US this corespods to a state

postal_code

a character string providing the postal code of a location.

status

a character string indicating the status of an entity in BreweryDb. Defaults to verified. Other possible status are new_new_unverified, update_pending, delete_pending and deleted

data_frame

a logical argument indicating if the function should return a data frame. Defaults to TRUE.

Value

By default the function returns a data frame. If data_frame = FALSE the function returns a list of responses - 1 for each page of results - created by GET


warlicks/beeR documentation built on May 28, 2019, 7:53 a.m.