phish_dot_net: Query the Phish.Net API

In MayaGans/phishr: Phish Related API Wrappers

Description

The phish.net API contains a vast amount of information. The functions here are specific to each type of query that can be sent to the API - all are prefixed with pn_*

Usage

pn_get_setlist(apikey = getOption("phishnet_key"), showdate = NULL)

pn_get_show_rating(apikey = getOption("phishnet_key"), showdate = NULL)

pn_get_show_notes(apikey = getOption("phishnet_key"), showdate = NULL)

Arguments

apikey	Your key for the Phish.net API. This can also be stored as an option using options('phishnet_key') <- 'your_api_key'. See details for more information on how to obtain one.
showdate	the show setlist in YYYY-MM-DD format

Details

Accessing the Phish.Net API requires an API key. These can be obtained by following the steps at Phish.net API keys. First, you'll need to create a username and password. After confirming your this information, you can follow the link above to create an API key. Once approved, store the private key somewhere that it is easily retrieved, and use it in the apikey argument to each pn_* function. Alternatively, you can set a option(phishnet_key = '<your-key'>) in your .Rprofile.

Value

the selected show's rating, setlist, or notes as a data.frame.

Examples

## Not run: 
BigCypressNYE <- pn_get_setlist(apikey = "<apikey>", showdate = "1999-12-31")

## End(Not run)

## Not run: 
BigCypressNYE <- get_show_rating(apikey = "<apikey>", showdate = "1999-12-31")

## End(Not run)
## Not run: 
BigCypressNYE <- get_show_notes(apikey = "<apikey>", showdate = "1999-12-31")

## End(Not run)

MayaGans/phishr documentation built on April 6, 2020, 3:35 a.m.