find_brewery: Find a brewery in BreweryDB

Description Usage Arguments

View source: R/find_brewery.R

Description

Find a brewery in BreweryDB

Usage

1
2
find_brewery(api_key, name = NULL, ids = NULL, established = 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.

name

a character string containing the name of a brewery.

ids

a character string or vector of character strings containing brewery ids.

established

a character string containing the year indicating the year a brewery or breweries where established. Must follow the format 'YYYY'.

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.

@return 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.