get_league_listing: Information about DotaTV-supported leagues

In LyzandeR/RDota2: An R Steam API Client for Valve's Dota2

Description

Information about DotaTV-supported leagues.

Usage

get_league_listing(dota_id = 570, language = "en", key = NULL)

Arguments

dota_id	Can take one of three values. 570 - Dota 2 (default) 816 - Dota 2 Internal Test 205790 - Dota 2 Beta Test
language	The ISO639-1 language code for returning all the information in the corresponding language. If the language is not supported, english will be returned. For a complete list of the ISO639-1 language codes please visit https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.
key	The api key obtained from Steam. If you don't have one please visit https://steamcommunity.com/dev in order to do so. For instructions on the correct way to use this key please visit https://github.com/LyzandeR/RDota2 and check the readme file. You can also see the examples. A key can be made available to all the functions by using key_actions. The key argument in individual functions should only be used in case the user needs to work with multiple keys.

Details

A list will be returned that contains three elements. The content, the url and the response received from the api.

The content is probably the most useful part for the user since it is a data.frame containing the information about the DotaTV-supported leagues. It consists of the five following columns:

• name: The league name.

• leagueid: The ID of the league (unique).

• description: A description containing information about the league.

• tournament_url: The website of the link.

• itemdef: Not documented on the API.

Value

A dota_api object containing the elements described in the details.

Steam API Documentation

https://wiki.teamfortress.com/wiki/WebAPI/GetLeagueListing

Examples

## Not run: 
get_league_listing()
get_league_listing(language = 'en', key = NULL)
get_league_listing(language = 'en', key = 'xxxxxxxxxxx')

## End(Not run)

LyzandeR/RDota2 documentation built on May 7, 2019, 2:03 p.m.