fdo_listComps: List of competitions from the football-data.org API

Description Usage Arguments Value Examples

View source: R/fdo.R

Description

Returns list of competitions from the football-data.org API

Usage

1
fdo_listComps(season = "", token = "", response = "full")

Arguments

season

(sting) The season (e.g. "2015") to which the competitions relate. Note that the convention is to take the starting year to indicate the season. For example, "2015/2016" is represented by "2015". Defaults to the current season.

token

(string) football data.org API token. Optional but it's recommended that you acquire an API token. It allows the owner to document API activity. See http://api.football-data.org/register for more details.

response

(string). Determine the structure of the response. Default is "full" and "minified" will remove some meta inforation and thus return a smaller data frame. Finally, "compressed" is only supported by the fixture resource.

Value

A data frame converted from the JSON format is returned.

Examples

1
2
3
4
5
6
7
## Not run: 
# defaults to current season
fdo_listComps()
# get list of 2015 competitions without metadata
fdo_listComps("2015",response = "minified")

## End(Not run)

dashee87/footballR documentation built on May 12, 2017, 5:40 p.m.