GetAll: Download all data for a specific FRC competition.

In irwinsnet/firstapiR: Tools to Download and Convert FIRST API Data to R Data Frames

Description

Downloads all data for a specific FRC competition and returns the data in a list of data frames, or character vectors containing XML or JSON text, depending on the format setting in the session variable. The list's named elements are listed below in the Value section.

Usage

GetAll(session, event)

Arguments

session	A Session object created with GetSession().
event	A character vector containing a FIRST API event code (see GetEvents).

Value

A list containing the following firstapiR elements which are data frames, XML character vectors, or JSON character vectors:

1. season: Season class. See GetSeason.

2. event: Events class. See GetEvents.

3. teams: Teams class, listing all teams in the competition. See GetTeams.

4. matches_qual: MatchResults class, for qualification matches. See GetMatchResults.

5. matches_playoff: MatchResults class, for playoffs. See GetMatchResults.

6. schedule_qual: Schedule class, for qualification matches. See GetSchedule.

7. schedule_playoff: Schedule class, for playoffs. See GetSchedule.

8. scores_qual: Scores class, for qualification matches. See GetScores.

9. scores_playoff: Scores class, for playoffs. See GetScores.

10. rankings: Rankings class. See GetRankings.

11. alliances: Alliances class. See GetAlliances.

12. awards: Awards class. See GetAwards.

GetAll will omit qualification-level elements and rankings if the event argument is set to "CMP", which corresponds to the finals on Einstein.

See Also

GetEvents

Examples

## Not run: 
sn <- GetSession("myUserName", "key", season = 2016)
archimedes <- GetAll(sn, "ARCHIMEDES")
SaveData(archimedes)

## End(Not run)

irwinsnet/firstapiR documentation built on Dec. 22, 2020, 5:13 p.m.