Description Usage Arguments Details Value Columns See Also Examples
Returns either the qualification schedule or the playoff schedule, based on
the value of the level
argument. The start
and end
arguments allow filtering of results to specific matches.
1 2 3 4 5 6 7 8 9 10 |
session |
A Session object created with |
event |
A character vector containing a FIRST API event code
(see |
level |
A character vector containing either "qual" or "playoff". Defaults to "qual". Optional. |
team |
An integer vector containing a team number. Optional. |
start |
An integer vector containing the earliest match to return. Optional. |
end |
An integer vector containing the latest match to return. Optional. |
mod_since |
A character vector containing an HTTP formatted date and
time. Returns |
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. |
The data frame returned by GetSchedule()
is in team shape, i.e., each
row contains data for a single team and there are six rows per match. Use
ToAllianceShape()
or ToMatchShape
to convert the data frame to
a three-teams-per-row shape or a six-teams-per-row shape.
See the Event Schedule 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/schedule/event?
tournamentLevel=level&teamNumber=team&start=start&end=end
Depending on the session$format
value, returns JSON text, an
XML::XMLDocument object, or a data.frame with class set to c("data.frame,
"Schedule"). 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
.
match: integer
description: character
level: factor
field: character
start: character
team: factor
alliance: factor (Blue, Red)
station: factor (Red1, Red2, Red3, Blue1, Blue2, Blue3)
surrogate: logical
Refer to Standard_attributes
for data
attributes returned by this function.
1 2 3 4 5 | sn <- GetSession("username", "key", season = 2016)
PNW_champs_qual_sched <- GetSchedule(sn, "PNCMP")
qual_matches_5_to_10 <- GetSchedule(sn, "PNCMP", start=5, end=10)
CWU_playoff_sched <- GetSchedule(sn, "WAAMV", level='playoff')
frc4911_matches_thru_25 <- GetSchedule(sn, "PNCMP", team=4911, end=25)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.