R/get_athlete.R

In fawda123/rStrava: Access the 'Strava' API

#' Get basic data for an athlete
#' 
#' Get basic athlete data for an athlete using an API request
#' 
#' @param stoken A \code{\link[httr]{config}} object created using the \code{\link{strava_oauth}} function
#' @param id string or integer of athlete
#' 
#' @details Requires authentication stoken using the \code{\link{strava_oauth}} function and a user-created API on the strava website.
#' 
#' @return A list of athlete information including athlete name, location, followers, etc. as described here: \url{https://strava.github.io/api/v3/athlete/}.
#' 
#' @concept token
#' 
#' @export
#' 
#' @import httr
#' 
#' @examples
#' \dontrun{
#' # 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')
#' }
get_athlete <-function(stoken, id = NULL){

	dataRaw <- get_basic(url_athlete(id), stoken)
	return(dataRaw)
	
}