Access catapultR

Please note that requests for access credentials to query data in OpenField Cloud are not guaranteed and are subject to capacity considerations. Please contact your customer success representative to inquire about access.

Guidelines for Responsible Use of Catapult Sports OpenField API

One of the main goals of the catapultR package is to help users access and analyze data efficiently. However, it is important to remember that most catapultR functions are simply wrappers around API calls. When used in excess, these functions have the potential to stress load the OpenField cloud. When using catapultR, please keep the following guidelines in mind:

• Avoid making excessive calls. Process data in smaller batches whenever possible. In particular, avoid unnecessary calls made in parallel. For example, when accessing 10 Hz data from inside a %dopar% loop, remember to use common sense. It is OK to call ofCloudGetActivitySensorData() for all athletes in a single activity inside %dopar% loop, but it is not OK to call ofCloudGetActivitySensorData() for all athletes in all activities inside %dopar% loop.

• If you are using Shiny consider caching the API results (e.g. activities).

• When using catapultR functions that inherently extend into multiple API calls like ofCloudGetActivitiesEx(), ofCloudGetActivitySensorDataEx() and ofCloudGetPeriodSensorDataEx(), use the common sense. For example, when using ofCloudGetActivitiesEx() to get all activities for the last year, it is OK to pass from and to parameters as a vector of 12 elements (an element per month). It is not OK passing a vector of 365 (an element per day).

• If you receive error code 429, then your APIs request rate is too high. You may also see a timeout error if you request too much data at once. Please review your code.

Thank you for being mindful of your API calls!

Install or Update catapultR

On 19 Nov 2024, the lastest version of catapultR available is:

catapultR 0.0.0.60

Use the code below to install or update catapultR.

devtools::install_bitbucket("catapultsports/catapultr", dependencies=TRUE, build_vignettes=TRUE)

In Windows, do not install dependent packages from source if prompted.

Query data stored in OF Cloud

catapultR is essentially* composed of wrapper functions of our API to provide users the ability to access their data from the cloud. In order to access the data in OpenField Cloud, you need the ability to generate secure login credentials enabled on your account. If you are a Catapult Sports customer and have the requisite coding skills to effectively utilize the package, please discuss this option with your Catapult Sports customer success contact.

*catapultR also provides some data manipulations like reading 100Hz csv and supports 10 Hz data from a mixed (dual stream) activities, which is not available through Connect.