Description Usage Arguments Details Value Columns See Also Examples
View source: R/firstapiR_main.R
The results vary depending on the season requested. The 2016 data fields are listed here. See the FIRST API documentation at http://docs.frcevents2.apiary.io/# for data fields for prior seasons. The data frame contains two rows for each match, one for blue and the other for red.
1 2 3 4 5 6 7 8 9 10 11 |
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. Cannot
specify |
match |
An integer vector containing a match number. Optional. If
specified, |
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. |
GetScores()
contains both the blue and red alliance scores for each
match, but it does not list the teams assigned to each alliance. Use
firstapiR MergeResults()
function to merge the data frames returned by
GetHybridSchedule
and GetScores()
to create a data frame that
contains both team numbers and detailed scores:
MergeResults(hybrid_df, scores_df)
should do the trick.
See the Detailed Scores 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/matches/event/level?
teamNumber=team&matchNumber=match&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,
"Scores"). 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
.
level: character
match: integer
audienceGroup: factor
alliance: factor
robot1Auto, robot2Auto, robot3Auto: factor
autoBouldersLow, autoBouldersHigh: integer
teleopBouldersLow, teleopBouldersHigh: integer
towerFaceA, towerFaceB, towerFaceC: factor
towerEndStrength: integer
teleopTowerCaptured, teleopDefensesBreached: logical
position1, position2, position3, position4, position5: factor
position1Crossings, position2Crossings, position3Crossings, position4Crossings, position5Crossings: integer
foulCount, techFoulCount: integer
autoPoints, autoReachPoints, autoCrossingPoints, autoBoulderPoints: integer
teleopPoints, teleopCrossingPoints, teleopBoulderPoints, teleopChallengePoints, teleopScalePoints: integer
breachPoints, capturePoints: integer
adustPoints, foulPoints, totalPoints: integer
Refer to Standard_attributes
for data attributes
returned by this function.
Refer to MergeResults
for guidance on how to merge the
Scores and HybridSchedule data frames.
1 2 3 4 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.