find_beer: Find a beer in BreweryDB

Description Usage Arguments Value

View source: R/find_beer.R

Description

Find a beer in BreweryDB

Usage

1
2
find_beer(api_key, name = NULL, ids = NULL, style_id = NULL,
  organic = 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 beer.

ids

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

style_id

a character string providing BreweryDB's ID for a beer style.

organic

a character string, either 'Y' or 'N' indicating if the beer is organic.

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.