fitzRoy (version 1.6.0)

fetch_squiggle_data: Access Squiggle data using the squiggle API service.

Description

Use fetch_squiggle_data to access the Squiggle API. See instructions at api.squiggle.com.au.

Usage

fetch_squiggle_data(
  query,
  ...,
  user_agent = "fitzRoy Package https://github.com/jimmyday12/fitzRoy"
)

Value

A dataframe, with the resultant data that matches the query specified in query, as well as any optional filters.

Arguments

query

A text string. The main query to use with the API. Please read the Squiggle documentation for information about valid queries

...

(optional) An optional argument provided to the Squiggle API. See details for more info.

user_agent

(optional) Use this to set something meaningful so that Squiggle admin can contact you if needed.

Details

Optional arguments can be provided to further restrict the data you are pulling.

For full instructions, see api.squiggle.com.au

Examples

if (FALSE) {
# Return a list of the sources, with ID's
sources <- fetch_squiggle_data("sources")

# Get tips for Round 1, 2018
tips <- fetch_squiggle_data(query = "tips", round = 1, year = 2018)

# Get tips from Squiggle 2019
squiggle <- fetch_squiggle_data(query = "tips", source = 1, year = 2019)
}