team3128/tba-analysis

Command line analysis for The Blue Alliance

The Blue Alliance Analysis

This tool allows users to query the team match data stored on The Blue Alliance in a command line manner. This is useful for aggregating team data into a single view, as well as creating custom metrics and more.

How to use TBA Anaylsis

TBA Analysis is a Javascript script, and can be included in any javascript project you are working on. However, to use it by itself, clone the repository and open index.html.

All commands should be entered via the Javascript console in your browser. Currently you might need to launch the web page on a self-hosted server in order to bypass certain Chrome security checks. You can also just use Firefox.

Argument Definitions

team_key is the team number prepended by frc. So, for Team 3128 the team key woudl be frc3128.

event_key is the letter code assigned by TheBlueAlliance/US FIRST prepended by the year of the event. For the San Diego Regional of 2015, it would be 2015casd. To find the event key, look at URLs for events pages of The Blue Alliance.

callback arguments are provided as the mechanism to receive data from the API. Pass a function that accepts a single argument that is the data object with the results of the query.

Available Commands

The TBA Anaylsis project is stored under the nar namespace.

nar.version() returns the version of TBA Analysis currently being ran.

nar.getTeamEventAverage( team_key, event_key, callback ); fetches and returns a team's match average to the provided callback. This match average is broken down into different match types: qm, ef, qf, sf, f.

nar.getTeamYearAverage( team_key, year, callback ); fetches and returns a the average of their event averages to the provided callback. This match average is broken down into different match types: qm, ef, qf, sf, f.

nar.getTeamsYearAverageByEvent( event_key, year, callback ); fetches all teams attending a the given event and returns their yearly average for the given year to the callback. This match average is broken down into different match types: qm, ef, qf, sf, f, and is separated by team.

tba-analysis's Issues

Create Server Back-End

Moving this from a simple command line tool to an actual exploration-oriented UI unfortunately means that there is a much higher amount of data that could get pulled.

Because of this, the Chrome Web Cache is no longer suitable for completely containing our dataset. In order to allow for more exploration, expanding to a server-oriented storage model is going to be very important.

This has some upsides, because it means that we can limit the traffic sent to The Blue Alliance because of the app, and we can do a lot more reports/data crunching because it is all stored on our severs. Also, we can make smaller summary tables that allow us to get our crunched data faster.

The question then goes to: what does it look like? where will we store it? etc.