Get recent achievements

Description

Get recent achievements, used internally in athl_fun

Usage

achievement_fun(prsd)

Arguments

Value

A data frame of recent achievements for the athlete. An empty list is returned if none found.

Get data for an athlete

Description

Get data for an athlete by web scraping, does not require authentication.

Usage

athl_fun(athl_num, trace = TRUE)

Arguments

Details

The athlete id is assigned to the user during registration with Strava and this must be known to use the function. Some users may have privacy settings that prevent public access to account information (a message indicating as such will be returned by the function). The function scrapes data using the following URL with the appended athlete id, e.g., https://www.strava.com/athletes/2837007. Opening the URL in a web browser can verify if the data can be scraped. Logging in to the Strava account on the website may also be required before using this function.

Value

A list for each athlete, where each element is an additional list with elements for the athlete's information. The list elements are named using the athlete id numbers.

Examples

## single athlete
athl_fun('2837007')

## multiple athletes
athl_fun(c('2837007', '2527465'))

Get data for a single athlete

Description

Get data for a single athlete by web scraping, does not require authentication.

Usage

athlind_fun(athl_num)

Arguments

Value

A list with elements for the athlete's information.

Remove activities with no geographic data

Description

Remove activities with no geographic data, usually manual entries

Usage

chk_nopolyline(act_data, ...)

## S3 method for class 'actframe'
chk_nopolyline(act_data, ...)

Arguments

Details

This function is used internally within get_elev_prof and get_heat_map to remove activities that cannot be plotted because they have no geographic information. This usually applies to activities that were manually entered.

Value

act_data with rows removed where no polylines were available, the original dataseset is returned if none were found. A warning is also returned indicating the row numbers that were removed if applicable.

Author(s)

Marcus Beck

Examples

## Not run: 
# get my activities
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))
my_acts <- get_activity_list(stoken)
act_data <- compile_activities(my_acts)
chk_nopolyline(act_data)

## End(Not run)

converts a list of activities into a dataframe

Description

converts a list of activities into a dataframe

Usage

compile_activities(actlist, acts = NULL, id = NULL, units = "metric")

Arguments

Details

each activity has a value for every column present across all activities, with NAs populating empty values

Value

An activities frame object (actframe that includes a data frame for the data and attributes for the distance, speed, and elevation units

Author(s)

Daniel Padfield

See Also

compile_club_activities for compiling an activities list for club activities

Examples

 
## Not run: 
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

my_acts <- get_activity_list(stoken)

acts_data <- compile_activities(my_acts)

# show attributes
attr(acts_data, 'unit_type')
attr(acts_data, 'unit_vals')

## End(Not run)

convert a single activity list into a dataframe

Description

convert a single activity list into a dataframe

Usage

compile_activity(x, columns)

Arguments

Details

used internally in compile_activities

Value

dataframe where every column is an item from a list. Any missing columns rom the total number of columns

Author(s)

Daniel Padfield

Examples

## Not run: 
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

acts <- get_activity_list(stoken)

compile_activity(acts[1])
## End(Not run)

Convert a set of streams of a single activity into a dataframe

Description

Convert a set of streams of a single activity into a dataframe, with the retrieved columns.

Usage

compile_activity_streams(streams, id = NULL)

Arguments

Details

used internally in get_activity_streams

Value

data frame where every column is the stream data for the retrieved types.

Author(s)

Lorenzo Gaborini

Examples

## Not run: 
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

act_id <- '351217692'
streams <- get_streams(stoken, id = act_id, types = list('distance', 'latlng'))

compile_activity_streams(streams, id = act_id)
## End(Not run)

converts a list of club activities into a dataframe

Description

converts a list of club activities into a dataframe

Usage

compile_club_activities(actlist)

Arguments

Details

each activity has a value for every column present across all activities, with NAs populating empty values

Value

An data.frame of the compiled activities from actlist

Author(s)

Marcus Beck

Examples

 
## Not run: 
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

club_acts <- get_activity_list(stoken, id = 13502, club = TRUE)

acts_data <- compile_club_activities(club_acts)


## End(Not run)

Compile the efforts of a segment

Description

Cleans up the output of get_efforts_list() into a dataframe

Usage

compile_seg_effort(x)

Arguments

Details

Used internally in compile_seg_efforts. Can be used on the output of get_efforts_list to compile the segment efforts of a single segment. Each call to get_efforts_list returns a large list. This function returns a subset of this information.

Value

A dataframe containing all of the efforts of a specific segment. The columns returned are athlete.id, distance, elapsed_time, moving_time, name, start_date and start_date_local.

Author(s)

Daniel Padfield

Examples

## Not run: 
# set token
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

# segments to get efforts from - use some parkruns
segment <- 2269028

# get segment efforts
efforts <- get_efforts_list(stoken, segment)

# compile efforts
efforts <- compile_seg_effort(efforts)

## End(Not run)

Compile the efforts of multiple segments

Description

Compiles the information of athletes from multiple segments

Usage

compile_seg_efforts(segment_ids, stoken)

Arguments

Details

Uses get_elev_prof and compile_seg_effort internally to compile efforts of multiple segments

Value

A dataframe of the details of each segment effort

Author(s)

Daniel Padfield

Examples

## Not run: 
# set token
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

# segments to get efforts from - use some parkruns
segments <- c(2269028, 5954625)

# compile segment efforts
segments %>% purrr::map_df(., .f = compile_seg_efforts, stoken = my_token, .id = 'id')

## End(Not run)

Compile information on a segment

Description

Compile generation information on a segment

Usage

compile_segment(seglist)

Arguments

Details

compiles information for a segment

Value

dataframe of all information given in a call from get_segment

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

# compile segment info
get_segment(stoken, id = '229781') %>% compile_segment

# compile top ten leaderboard for the segment
get_segment(stoken, id = '229781', request = "leaderboard") %>% compile_segment

# compile all efforts for the authenticated user on the segment
get_segment(stoken, id = '4483903', request = 'all_efforts') %>% compile_segment

# compile the starred segments for the user
get_segment(stoken, request = 'starred') %>% compile_segment

## End(Not run)

Filter

Description

This is a wrapper function to dplyr::filter which can be applied to an actframe object

Usage

## S3 method for class 'actframe'
filter(.data, ...)

Arguments

Value

an actframe object

Examples

## Not run: 
library(dplyr)

# get actframe, all activities
stoken <- httr::config(
  token = strava_oauth(
    app_name, 
    app_client_id, 
    app_secret, 
    app_scope="activity:read_all"
  )
)
my_acts <- get_activity_list(stoken)
act_data <- compile_activities(my_acts)

# mutate
act_data %>% filter(name %in% 'Morning Ride')

## End(Not run)

Get athlete follow data

Description

Get athlete follow data, used internally in athl_fun

Usage

follow_fun(prsd)

Arguments

Value

A data frame of counts of followers and following for the athlete. An empty list is returned if none found.

Get KOMs/QOMs/CRs of an athlete

Description

Get KOMs/QOMs/CRs of an athlete

Usage

get_KOMs(id, stoken)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_KOMs('2837007', stoken)

## End(Not run)

Get detailed data of an activity

Description

Get detailed data of an activity, including segment efforts

Usage

get_activity(id, stoken)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

The id for each activity can be viewed using results from get_activity_list.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_activity('75861631', stoken)

## End(Not run)

Get an activities list

Description

Get an activities list of the desired type (club, user)

Usage

get_activity_list(stoken, id = NULL, before = NULL, after = NULL, club = FALSE)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website. If retrieving activities using individual id values, the output list returned contains additional information from the API and the results have not been tested with the functions in this package. It is better practice to retrieve all activities (as in the example below), use compile_activities, and then filter by individual activities.

If retrieving club activities, the user for the API must be a member of the club.

Value

A list of activities for further processing or plotting.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_activity_list(stoken)

## End(Not run)

Retrieve streams for activities, and convert to a dataframe

Description

Retrieve streams for activities, and convert to a dataframe.

Usage

get_activity_streams(act_data, ...)

## S3 method for class 'list'
get_activity_streams(
  act_data,
  stoken,
  acts = NULL,
  id = NULL,
  types = NULL,
  resolution = "high",
  series_type = "distance",
  ...
)

## S3 method for class 'actframe'
get_activity_streams(
  act_data,
  stoken,
  types = NULL,
  resolution = "high",
  series_type = "distance",
  ...
)

Arguments

Details

Each activity has a value for every column present across all activities, with NAs populating missing values.

For the types argument, the default is type = NULL which will retrieve all available stream types. The available stream types can be any of time, latlng, distance, altitude, velocity_smooth, heartrate, cadence, watts, temp, moving, or grade_smooth. To retrieve only a subset of the types, pass a list argument with the appropriate character strings to type, e.g., type = list("time", "latlng", "distance").

Invalid HTTP requests (404 or 400 code) may sometimes occur for activities with incomplete data, e.g., stationary activities with no distance information. In such cases, changing the 'series_type' and 'resolution' arguments may be needed, e.g., 'series_type = "time"' and 'resolution = "medium"'.

Value

A stream frame object (strframe that includes a data frame for the stream data along with the units

Author(s)

Lorenzo Gaborini

Examples

 
## Not run: 
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

my_acts <- get_activity_list(stoken) 

strms_data <- get_activity_streams(my_acts, stoken, acts = 1:2)


## End(Not run)

Get basic data for an athlete

Description

Get basic athlete data for an athlete using an API request

Usage

get_athlete(stoken, id = NULL)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

A list of athlete information including athlete name, location, followers, etc. as described here: https://strava.github.io/api/v3/athlete/.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_athlete(stoken, id = '2527465')

## End(Not run)

Get basic Strava data

Description

Get basic Strava data with requests that don't require pagination

Usage

get_basic(url_, stoken, queries = NULL)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

# get basic user info
get_basic('https://strava.com/api/v3/athlete', stoken)

## End(Not run)

Get club data

Description

Get club data for a given request

Usage

get_club(stoken, id = NULL, request = NULL)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_club(stoken)

## End(Not run)

Get distance from longitude and latitude points

Description

Get distance from longitude and latitude points

Usage

get_dists(lon, lat)

Arguments

Details

Used internally in get_elev_prof on objects returned by get_latlon

Value

A vector of distances with the length as the number of rows in dat_in

Author(s)

Daniel Padfield

Examples

## Not run: 
# get activity data
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))
my_acts <- get_activity_list(stoken)

# get the latest activity
acts_data <- compile_activities(my_acts)[1, ]

# get lat, lon
polyline <- acts_data$map.summary_polyline
latlon <- get_latlon(polyline, key = mykey)

# get distance
get_dists(latlon$lon, latlon$lat)

## End(Not run)

Get all the efforts in a segment if no queries are specified

Description

Get all the efforts in a segment if no queries are specified

Usage

get_efforts_list(
  stoken,
  id,
  athlete_id = NULL,
  start_date_local = NULL,
  end_date_local = NULL
)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_efforts_list(stoken, id = '229781')

## End(Not run)

Create elevation profiles from activity data

Description

Create elevation profiles from activity data

Usage

get_elev_prof(act_data, ...)

## S3 method for class 'list'
get_elev_prof(
  act_data,
  acts = 1,
  id = NULL,
  key,
  total = FALSE,
  expand = 10,
  units = "metric",
  fill = "darkblue",
  ...
)

## S3 method for class 'actframe'
get_elev_prof(
  act_data,
  key,
  total = FALSE,
  expand = 10,
  fill = "darkblue",
  ...
)

## S3 method for class 'strframe'
get_elev_prof(act_data, total = FALSE, expand = 10, fill = "darkblue", ...)

Arguments

Details

The Google API key is easy to obtain, follow instructions here: https://developers.google.com/maps/documentation/elevation/#api_key

Value

A ggplot of elevation profiles, facetted by activity id, date

Author(s)

Daniel Padfield, Marcus Beck

See Also

get_dists

Examples

## Not run: 
# get my activities
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))
my_acts <- get_activity_list(stoken)

# your unique key
mykey <- 'Get Google API key'
get_elev_prof(my_acts, acts = 1:2, key = mykey)

# compile first, change units
my_acts <- compile_activities(my_acts, acts = c(1:2), units = 'imperial')
get_elev_prof(my_acts, key = mykey)

## End(Not run)

Explore segments within a bounded area

Description

Explore segments within a bounded area

Usage

get_explore(
  stoken,
  bounds,
  activity_type = "riding",
  max_cat = NULL,
  min_cat = NULL
)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

bnds <- "37.821362, -122.505373, 37.842038, -122.465977"
get_explore(stoken, bnds)

## End(Not run)

Get gear details from its identifier

Description

Get gear details from its identifier

Usage

get_gear(id, stoken)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_gear("2275365", stoken)

## End(Not run)

Makes a heat map from your activity data

Description

Makes a heat map from your activity data

Usage

get_heat_map(act_data, ...)

## S3 method for class 'list'
get_heat_map(
  act_data,
  key,
  acts = 1,
  id = NULL,
  alpha = NULL,
  add_elev = FALSE,
  as_grad = FALSE,
  distlab = TRUE,
  distval = 0,
  size = 0.5,
  col = "red",
  expand = 10,
  maptype = "CartoDB.Positron",
  zoom = 14,
  units = "metric",
  ...
)

## S3 method for class 'actframe'
get_heat_map(
  act_data,
  key,
  alpha = NULL,
  add_elev = FALSE,
  as_grad = FALSE,
  distlab = TRUE,
  distval = 0,
  size = 0.5,
  col = "red",
  expand = 10,
  maptype = "CartoDB.Positron",
  zoom = 14,
  ...
)

## S3 method for class 'strframe'
get_heat_map(
  act_data,
  alpha = NULL,
  filltype = "elevation",
  distlab = TRUE,
  distval = 0,
  size = 0.5,
  col = "red",
  expand = 10,
  maptype = "CartoDB.Positron",
  zoom = 14,
  ...
)

Arguments

Details

uses get_latlon to produce a dataframe of latitudes and longitudes to use in the map. Uses ggspatial to produce the map and ggplot2 to plot the route.

A Google API key is needed for the elevation data and must be included with function execution. The API key can be obtained following the instructions here: https://developers.google.com/maps/documentation/elevation/#api_key

The distval argument is passed to the digits argument of round. This controls the density of the distance labels, e.g., 1 will plot all distances in sequence of 0.1, 0 will plot all distances in sequence of one, -1 will plot all distances in sequence of 10, etc.

The base map type is selected with the maptype argument. The zoom value specifies the resolution of the map. Use higher values to download map tiles with greater resolution, although this increases the download time. Acceptable options for maptype include "OpenStreetMap", "OpenStreetMap.DE", "OpenStreetMap.France", "OpenStreetMap.HOT", "OpenTopoMap", "Esri.WorldStreetMap", "Esri.DeLorme", "Esri.WorldTopoMap", "Esri.WorldImagery", "Esri.WorldTerrain", "Esri.WorldShadedRelief", "Esri.OceanBasemap", "Esri.NatGeoWorldMap", "Esri.WorldGrayCanvas", "CartoDB.Positron", "CartoDB.PositronNoLabels", "CartoDB.PositronOnlyLabels", "CartoDB.DarkMatter", "CartoDB.DarkMatterNoLabels", "CartoDB.DarkMatterOnlyLabels", "CartoDB.Voyager", "CartoDB.VoyagerNoLabels", or "CartoDB.VoyagerOnlyLabels".

Value

A ggplot object showing a map with activity locations.

Author(s)

Daniel Padfield, Marcus Beck

Examples

## Not run: 
# get my activities
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))
my_acts <- get_activity_list(stoken)

# default, requires Google key
mykey <- 'Get Google API key'
get_heat_map(my_acts, acts = 1, alpha = 1, key = mykey)

# plot elevation on locations, requires key
get_heat_map(my_acts, acts = 1, alpha = 1, key = mykey, add_elev = TRUE, col = 'Spectral', size = 2)

# compile first, change units
my_acts <- compile_activities(my_acts, acts = 156, units = 'imperial')
get_heat_map(my_acts, key = mykey, alpha = 1, add_elev = T, col = 'Spectral', size = 2)

## End(Not run)

Retrieve the laps of an activity

Description

Retrieve the laps of an activity

Usage

get_laps(stoken, id)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_laps(stoken, id = '351217692')

## End(Not run)

get latitude and longitude from Google polyline

Description

get latitude and longitude from Google polyline

Usage

get_latlon(polyline, key)

Arguments

Value

dataframe of latitude and longitudes with a column for the unique identifier

Author(s)

Daniel Padfield, Marcus Beck

Examples

## Not run: 
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))

my_acts <- get_activity_list(stoken)
acts_data <- compile_activities(my_acts)

# get lat and lon for a single activity
polyline <- acts_data$map.summary_polyline[[1]]
get_latlon(polyline, key = mykey)

## End(Not run)

Retrieve the leaderboard of a segment

Description

Retrieve the leaderboard of a segment

Usage

get_leaderboard(stoken, id, nleaders = 10, All = FALSE)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_leaderboard(stoken, id = '229781')

## End(Not run)

Get several pages of one type of request

Description

Get several pages of one type of request to the API

Usage

get_pages(
  url_,
  stoken,
  per_page = 30,
  page_id = 1,
  page_max = 1,
  before = NULL,
  after = NULL,
  queries = NULL,
  All = FALSE
)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

# get basic user info
# returns 30 activities
get_pages('https://strava.com/api/v3/activities', stoken)


## End(Not run)

Retrieve details about a specific segment

Description

Retreive details about a specific segment

Usage

get_segment(stoken, id = NULL, request = NULL)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website. The authenticated user must have an entry for a segment to return all efforts if request = "all_efforts". For request = "starred", set id = NULL.

Value

Data from an API request.

See Also

compile_segment for converting the list output to data.frame

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

# get segment info
get_segment(stoken, id = '229781')

# get top ten leaderboard for the segment
get_segment(stoken, id = '229781', request = "leaderboard")

# get all efforts for the authenticated user on the segment
get_segment(stoken, id = '4483903', request = 'all_efforts')

# get the starred segments for the user
get_segment(stoken, request = 'starred') 

## End(Not run)

Get speed splits in a dataframe

Description

Allows the return of speed splits of multiple rides.

Usage

get_spdsplits(act_id, stoken, units = "metric")

Arguments

Value

a data frame containing the splits of the activity or activities selected.

Author(s)

Marcus Beck

Examples

## Not run: 
# get my activities
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))
my_acts <- get_activity_list(stoken)

# compile activities
acts_data <- compile_activities(my_acts)

# get spdsplits for all activities
spd_splits <- purrr::map_df(acts_data$id, get_spdsplits, stoken = stoken, 
     units = 'metric', .id = 'id')

## End(Not run)

Retrieve a summary of the segments starred by an athlete

Description

Retrieve a summary of the segments starred by an athlete

Usage

get_starred(stoken, id = NULL)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_starred(stoken)

## End(Not run)

Retrieve a Strava data stream for a single activity

Description

Retrieve a Strava data stream for a single activity. Internally called by get_activity_streams.

Usage

get_streams(
  stoken,
  id,
  request = "activities",
  types = NULL,
  resolution = NULL,
  series_type = NULL
)

Arguments

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website. From the API documentation, 'streams' is the Strava term for the raw data associated with an activity.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_streams(stoken, id = '351217692', types = list('distance', 'latlng'))

## End(Not run)

Get athlete location

Description

Get athlete location, used internally in athl_fun

Usage

location_fun(prsd)

Arguments

Value

A character string of the athlete location

Get distance and time for current month

Description

Get distance and time for current month, used internally in athl_fun

Usage

monthly_fun(prsd)

Arguments

Value

A data frame of the current monthly distance and time for the athlete. An empty list is returned if none found.

Mutate

Description

This is a wrapper function to dplyr::mutate which can be applied to an actframe object

Usage

## S3 method for class 'actframe'
mutate(.data, ...)

Arguments

Value

an actframe object

Examples

## Not run: 
library(dplyr)

# get actframe, all activities
stoken <- httr::config(
  token = strava_oauth(
    app_name, 
    app_client_id, 
    app_secret, 
    app_scope="activity:read_all"
  )
)
my_acts <- get_activity_list(stoken)
act_data <- compile_activities(my_acts)

# mutate
act_data %>% mutate(is_run=type=='Run')

## End(Not run)

Plot speed by splits

Description

Plot average speed by splits for a single activity

Usage

plot_spdsplits(act_data, ...)

## S3 method for class 'list'
plot_spdsplits(
  act_data,
  stoken,
  acts = 1,
  id = NULL,
  units = "metric",
  fill = "darkblue",
  ...
)

## Default S3 method:
plot_spdsplits(act_data, stoken, units = "metric", fill = "darkblue", ...)

Arguments

Details

The average speed per split is plotted, including a dashed line for the overall average. The final split is typically not a complete km or mile.

Value

plot of average distance for each split value in the activity

Author(s)

Marcus Beck

Examples

## Not run: 
# get my activities
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, app_secret, cache = TRUE))
my_acts <- get_activity_list(stoken)

# default
plot_spdsplits(my_acts, stoken, acts = 1)

## End(Not run)

Generate the ratelimit indicator

Description

Checks the ratelimit values after the last request and stores the left requests in a global variable.

Usage

ratelimit(req)

Arguments

Details

Requests to the Strava API are rate-limited. The default rate limit allows 600 requests every 15 minutes, with up to 30,000 requests per day. See the documentation at https://strava.github.io/api/#access.

Value

A variable for the current limits.

Get last three recent activities

Description

Get last three recent activities, used internally in athl_fun

Usage

recent_fun(prsd)

Arguments

Value

A data frame of recent activities for the athlete. An empty list is returned if none found.

Format before and after arguments for API query

Description

Format before and after arguments for API query

Usage

seltime_fun(dtin, before = TRUE)

Arguments

Value

A numeric object as an epoch timestamp

Examples

# convert to epoch timestamp
seltime_fun(Sys.Date())

# back to original 
as.POSIXct(seltime_fun(Sys.Date(), before = FALSE), tz = Sys.timezone(), origin = '1970-01-01')

Generata Strava API authentication token

Description

Generate a token for the user and the desired scope. The user is sent to the strava authentication page if he/she hasn't given permission to the app yet, else, is sent to the app webpage.

Usage

strava_oauth(
  app_name,
  app_client_id,
  app_secret,
  app_scope = "public",
  cache = FALSE
)

Arguments

Details

The app_name, app_client_id, and app_secret are specific to the user and can be obtained by registering an app on the Strava API authentication page: http://strava.github.io/api/v3/oauth/. This requires a personal Strava account.

Value

A Token2.0 object returned by oauth2.0_token to be used with API function calls

Examples

## Not run: 
app_name <- 'myappname' # chosen by user
app_client_id  <- 'myid' # an integer, assigned by Strava
app_secret <- 'xxxxxxxx' # an alphanumeric secret, assigned by Strava

# create the authentication token
stoken <- httr::config(
  token = strava_oauth(
    app_name, 
    app_client_id, 
    app_secret, 
    app_scope="activity:read_all"
  )
)

# use authentication token
get_athlete(stoken, id = '2837007')

## End(Not run)

Get athlete trophies

Description

Get athlete trophies, used internally in athl_fun

Usage

trophy_fun(prsd)

Arguments

Value

A data frame of trophies for the athlete. An empty list is returned if none found.

Set the url of activities for different activity lists

Description

Set the url of activities for different activity lists

Usage

url_activities(id = NULL, club = FALSE)

Arguments

Details

This function concatenates appropriate strings so no authentication token is required. This is used internally by other functions.

Value

The set url.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

url_activities('2837007')

## End(Not run)

Set the url of the athlete to get data

Description

Set the url of the athlete to get data using an ID

Usage

url_athlete(id = NULL)

Arguments

Details

used by other functions

Value

A character string of the athlete URL used for API requests

Set the url of the clubs for the different requests

Description

Set the url of the clubs for the different requests

Usage

url_clubs(id = NULL, request = NULL)

Arguments

Details

Function is used internally within get_club

Value

A url string.

Examples

url_clubs()

url_clubs('123', request = 'members')

Set the url of the equipment item to get data

Description

Set the url of the equipment item to get data using an ID

Usage

url_gear(id)

Arguments

Details

used by other functions

Value

A character string of the gear URL used for API requests

Set the url for the different segment requests

Description

Set the url for the different segment requests

Usage

url_segment(id = NULL, request = NULL)

Arguments

Details

Function is used internally within get_segment, get_starred, get_leaderboard, get_efforts_list, and get_explore

Value

A url string.

Examples

url_segment()

url_segment(id = '123', request = 'leaderboard')

Set the url for stream requests

Description

Set the url for stream requests

Usage

url_streams(id, request = "activities", types = list("latlng"))

Arguments

Details

Function is used internally within get_streams. From the API documentation, 'streams' is the Strava term for the raw data associated with an activity.

Value

A url string.

Examples

url_streams('123')