getDistrictEvents: FRC events in a given district and year.

In BillDunlap/TheBlueAlliance: Use FIRST Robotics Competition data from thebluealliance.com

FRC events in a given district and year.

Description

Get information on FRC events in a given district and year.

Usage

getDistrictEvents(district, year = defaultYear(), districtKey = paste0(year, district), simple = TRUE, authKey = defaultAuthKey())

Arguments

district	A character string giving the abbreviation for the district. Use getDistricts() to get a list of them.
year	The year of interest.
districtKey	A character string of the form "<year><district>".
simple	A logical value. If TRUE, then give only the commonly desired information on a district; if FALSE, then give more details.
authKey	Your authentication key for TheBlueAlliance.com.

Value

A data.frame with one entry for each event with components

city	A character string giving the event's city.
country	A character string giving the event's country.
district	A data.frame describing the district.
end_date	A 'Date' giving the last day of the event.
event_code	A character string giving a short identifier for the event.
event_type	An integer giving the event type code: 0=Regional, 1=District, 2=District Championship, 3=Championship Division, 4=Championship Finals, 5=District Championship Division, 99=Offseason, 100=Preseason

. Etc.

Note

Some regions use the "district" model for events, where teams compete in two events and the top ranked teams in those events compete at the district championship. Others use the "regional" model and teams compete only in a regional championship. The highest ranked teams in the district or regional championships advance to the (world) championship event. See https://www.firstinspires.org/resource-library/frc/district-regional-teams for more information on these models.

The larger championship events may run several "divisional" events concurrently, with the division winners advancing to the championship finals.

See Also

getDistricts(year) will list the district names and codes for a given year.

Examples

e <- getDistrictEvents("pnw", year=2022)$event_code

BillDunlap/TheBlueAlliance documentation built on April 29, 2022, 12:23 a.m.