firstapiR: firstapiR 2.0.1: R Functions for Connecting to the FIRST API...

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

Description

The firstapiR package provides functions that connect to the FIRST API server and download data on FIRST Robotics Competition (FRC) teams, events, match results, and awards. FirstapiR also contains utility functions for reshaping data frames into wide or long formats, and to save FRC data to local files.

Details

The FIRST API accepts formatted hypertext transfer protocol (HTTP) GET requests and provides FRC data in either javascript object notation (JSON) or extensible markup language (XML) format. Detailed documentation for the FIRST API, including precise rules for constructing the HTTP requests, is available at http://docs.frcevents2.apiary.io/#

A username and authorization key are required for connecting to the FIRST API and for using firstapiR. To obtain a username and key, join the FIRST Community Developers project on TeamForge at https://usfirst.collab.net/sf/projects/first_community_developers/

These functions return R dataframes by default. Optionally, the functions can also return the raw JSON or XML that is provided by the FIRST API. See the apiary documentation (http://docs.frcevents2.apiary.io/#) for a detailed description of all response data fields.

These functions use version 2.0 of the FIRST API. They have not been tested with version 1.0.

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