| Title: | PelotonR Pulls Data From The Peloton Apis |
|---|---|
| Description: | pelotonR pulls data from the Peloton APIs. |
| Authors: | Laura Ellis [aut, cre] |
| Maintainer: | Laura Ellis <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.0 |
| Built: | 2025-02-27 05:18:32 UTC |
| Source: | https://github.com/ats/pelotonR |
This function augments a data frame obtained from get_workouts_df with some time and duration information.
augment_peloton_df(df, tzone = "America/Los_Angeles")augment_peloton_df(df, tzone = "America/Los_Angeles")
df |
Peloton data frame to process |
tzone |
Name of time zone to convert the original UTC time from. Defaults to "America/Los_Angeles" |
augment_peloton_df()augment_peloton_df()
This function allows you to authenticate with the Peloton API to pull your details and workout stats. In this function you are able to pass in your 'username' and 'password'. If you pass in no value, the system will prompt you for a user name and password.
authenticate(username, password)authenticate(username, password)
username |
Your Peloton screen name. |
password |
Your Peloton password. |
authenticate() authenticate("example user name", "example password")authenticate() authenticate("example user name", "example password")
This function returns a data frame with a subset of information related to a particular ride.
get_basic_ride_info_df(ride_id)get_basic_ride_info_df(ride_id)
ride_id |
The id of the ride that you are pulling information for. |
get_basic_ride_info_df("55214456a1984c5885a087021e3f67b7")get_basic_ride_info_df("55214456a1984c5885a087021e3f67b7")
This function returns a data frame with all instructor information.
get_instructors_df()get_instructors_df()
get_instructors_df()get_instructors_df()
This function returns a data frame with all current live rides as well as the joined ride and instructor data for each ride.
get_live_ride_and_details_df()get_live_ride_and_details_df()
get_live_ride_and_details_df()get_live_ride_and_details_df()
This function returns a data frame with all of the current live rides.
get_live_rides_df()get_live_rides_df()
get_live_rides_df()get_live_rides_df()
This function returns a data frame of metadata available on Peloton for a particular category type.
get_metadata_mapping_df(type)get_metadata_mapping_df(type)
type |
The type of metadata to pull. Available data types include: 'instructors', 'class_types', 'equipment', 'fitness_disciplines', device_type_display_names', 'content_focus_labels', |
get_metadata_mapping_df("fitness_disciplines") get_metadata_mapping_df("equipment")get_metadata_mapping_df("fitness_disciplines") get_metadata_mapping_df("equipment")
This function will gather all stats for the current authenticated user and return the results in a list.
get_my_stats_list()get_my_stats_list()
get_my_stats_list()get_my_stats_list()
This function will gather the workout counts by category for the current authenticated user.
get_my_workout_stats_df()get_my_workout_stats_df()
get_my_workout_stats_df()get_my_workout_stats_df()
This function returns a list with all information related to a particular ride.
get_ride_info_list(ride_id)get_ride_info_list(ride_id)
ride_id |
The id of the ride that you are pulling information for. |
get_ride_info_list("55214456a1984c5885a087021e3f67b7")get_ride_info_list("55214456a1984c5885a087021e3f67b7")
This function will gather all individual workouts and all related instructor data for a user and return it in a data frame. If a user id is not passed into the function, it will return the current users workouts.
get_workouts_and_instructors_df(user_id, pages = 0)get_workouts_and_instructors_df(user_id, pages = 0)
user_id |
Your Peloton user id. |
pages |
Integer number of pages to retrieve from API (defaults to 0 for no limit) |
get_workouts_and_instructors_df()get_workouts_and_instructors_df()
This function will gather all individual workouts for a specified user and return the results in a data frame. If a user id is not passed into the function, it will return the current users workouts.
get_workouts_df(user_id, pages = 0)get_workouts_df(user_id, pages = 0)
user_id |
Peloton user id. |
pages |
Integer number of pages to retrieve from API (defaults to 0, which specifies no limit) |
get_workouts_df()get_workouts_df()