GetSeason: Get high-level information for an FRC season

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

Description

Returns information for the season specified in the session list (see documentation for the GetSession function for additional details.)

Usage

GetSeason(session, mod_since = NULL, only_mod_since = NULL)

Arguments

session	A Session object created with GetSession().
mod_since	A character vector containing an HTTP formatted date and time. Returns NA if no changes have been made to the requested data since the date and time provided. Optional.
only_mod_since	A character vector containing an HTTP formatted date and time. This function only returns data that has changed since the date and time provided. Optional.

Details

See the Season Summary section of the FIRST API documentation at http://docs.frcevents2.apiary.io/# for more details.

The FIRST API URL format is:

https://frc-api.firstinspires.org/v2.0/season

Value

Depending on the session$format value, returns JSON text, an XML::XMLDocument object, or a data.frame with class set to c("data.frame, "Season"). Returns a logical vector of length one with value NA if data is unchanged since date and time passed in arguments mod_since or only_mod_since.

Columns

1. eventCount: integer

2. gameName: factor

3. kickoff: factor

4. rookieStart: integer

5. teamCount: integer

6. FRCChampionships.name: character

7. FRCChampionships.startDate: character

8. FRCChampionships.location: character

See Also

Refer to Standard_attributes for data attributes returned by this function.

Refer to GetSession for information on specifying the FRC season.

Examples

sn <- GetSession("username", "key", season = 2015, staging = TRUE)
summary <- GetSeason(sn)

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