Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling rhs(lhs).

Generate an Oauth token

Description

Performs the OAuth 2.0 dance to create a token to use with the Fitbit API.

Usage

generate_fitbitr_token(
  app_name = "fitbitr",
  client_id = Sys.getenv("FITBIT_CLIENT_ID"),
  client_secret = Sys.getenv("FITBIT_CLIENT_SECRET"),
  callback = Sys.getenv("FITBIT_CALLBACK", "https://localhost:1410/"),
  scope = c("activity", "cardio_fitness", "electrocardiogram", "heartrate", "location",
    "nutrition", "oxygen_saturation", "profile", "respiratory_rate", "settings", "sleep",
    "social", "temperature", "weight"),
  cache = TRUE,
  use_basic_auth = TRUE,
  ...
)

Arguments

Details

Saves a token as .fitbitr_token which can then be used in the background to authorize requests

Value

Returns an OAuth 2.0 token (invisibly) that can be used to authorize requests to the Fitbit API. Also saves the token to .fitbitr_token.

Examples

## Not run: 
generate_fitbitr_token(
  client_id = <YOUR-CLIENT-ID>
  client_secret = <YOUR-CLIENT-SECRET>,
  cache = TRUE
)

## End(Not run)

Get intraday active zone minutes time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_active_zone_minutes_intraday(
  date = lubridate::today(),
  detail_level = c("1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

See Also

Other intraday: get_calories_intraday(), get_distance_intraday(), get_elevation_intraday(), get_floors_intraday(), get_heart_rate_intraday(), get_steps_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_active_zone_minutes_intraday(detail_level = "15min")

## get more granular data
get_active_zone_minutes_intraday(detail_level = "1min")

## End(Not run)

Activity Calories Time Series

Description

Resource path /activities/activityCalories

Usage

get_activity_calories(start_date, end_date)

Arguments

Value

A tibble with two columns: date and activity_calories

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_activity_calories(date)

## End(Not run)

Activity Summary

Description

See https://dev.fitbit.com/build/reference/web-api/activity/ for more details.

Usage

get_activity_summary(date)

Arguments

Value

A tibble with the date and a number of activity summary metrics for the day.

Examples

## Not run: 
date <- lubridate::today()
get_activity_summary(date)

## End(Not run)

Calories Time Series

Description

Resource path /activities/calories

Usage

get_calories(start_date, end_date)

Arguments

Value

A tibble with two columns: date and calories

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
calories(date)

## End(Not run)

Calories BMR Time Series

Description

Resource path /activities/caloriesBMR

Usage

get_calories_bmr(start_date, end_date)

Arguments

Value

A tibble with two columns: date and calories_bmr

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_calories_bmr(date)

## End(Not run)

Get intraday calories time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_calories_intraday(
  date = lubridate::today(),
  detail_level = c("1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

Value

A tibble with two columns: time and calories

See Also

Other intraday: get_active_zone_minutes_intraday(), get_distance_intraday(), get_elevation_intraday(), get_floors_intraday(), get_heart_rate_intraday(), get_steps_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_calories_intraday(detail_level = "15min")

## get more granular data
get_calories_intraday(detail_level = "1min")

## End(Not run)

Distance Time Series

Description

Resource path /activities/distance

Usage

get_distance(start_date, end_date)

Arguments

Value

A tibble with two columns: date and distance

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_distance(date)

## End(Not run)

Get intraday distance time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_distance_intraday(
  date = lubridate::today(),
  detail_level = c("1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

Value

A tibble with two columns: time and distance

See Also

Other intraday: get_active_zone_minutes_intraday(), get_calories_intraday(), get_elevation_intraday(), get_floors_intraday(), get_heart_rate_intraday(), get_steps_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_distance_intraday(detail_level = "15min")

## get more granular data
get_distance_intraday(detail_level = "1min")

## End(Not run)

Elevation Time Series

Description

Resource path /activities/elevation

Usage

get_elevation(start_date, end_date)

Arguments

Value

A tibble with two columns: date and elevation

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_elevation(date)

## End(Not run)

Get intraday elevation time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_elevation_intraday(
  date = lubridate::today(),
  detail_level = c("1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

Value

A tibble with two columns: time and elevation

See Also

Other intraday: get_active_zone_minutes_intraday(), get_calories_intraday(), get_distance_intraday(), get_floors_intraday(), get_heart_rate_intraday(), get_steps_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_elevation_intraday(detail_level = "15min")

## get more granular data
get_elevation_intraday(detail_level = "1min")

## End(Not run)

Floors Time Series

Description

Resource path /activities/floors

Usage

get_floors(start_date, end_date)

Arguments

Value

A tibble with two columns: date and floors

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_floors(date)

## End(Not run)

Get intraday floors time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_floors_intraday(
  date = lubridate::today(),
  detail_level = c("1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

Value

A tibble with two columns: time and floors

See Also

Other intraday: get_active_zone_minutes_intraday(), get_calories_intraday(), get_distance_intraday(), get_elevation_intraday(), get_heart_rate_intraday(), get_steps_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_floors_intraday(detail_level = "15min")

## get more granular data
get_floors_intraday(detail_level = "1min")

## End(Not run)

Get intraday heart time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_heart_rate_intraday(
  date = lubridate::today(),
  detail_level = c("1sec", "1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

See Also

Other intraday: get_active_zone_minutes_intraday(), get_calories_intraday(), get_distance_intraday(), get_elevation_intraday(), get_floors_intraday(), get_steps_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_heart_rate_intraday(detail_level = "15min")

## get more granular data
get_heart_rate_intraday(detail_level = "1min")

## End(Not run)

Heart Rate Zones

Description

See https://dev.fitbit.com/build/reference/web-api/activity/ for more details.

Usage

get_heart_rate_zones(start_date, end_date = start_date)

Arguments

Value

A tibble of the date, the heart rate zone (zone), the minimum heart rate in that zone (min_hr), the maximum heart rate in that zone (max_hr), the minutes in that zone (minutes_in_zone), and the calories burned in that zone (calories_out)

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()

get_heart_rate_zones(start_date, end_date)

## End(Not run)

Get an intraday time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_intraday_time_series(
  resource = c("active-zone-minutes", "calories", "distance", "elevation", "floors",
    "heart", "steps"),
  date,
  detail_level,
  start_time,
  end_time
)

Arguments

Value

A tibble with two columns: time and {{resource}}

Lifetime Bests

Description

Retrieve lifetime best distance, floors, and steps

Usage

get_lifetime_bests()

Value

A tibble the best distance, floors, and steps (by date) tracked on any of your trackers

Examples

## Not run: 
get_lifetime_bests()

## End(Not run)

Lifetime Totals

Description

Retrieve lifetime total distance, floors, and steps

Usage

get_lifetime_totals()

Value

A tibble of all-time totals across trackers (i.e. the total distance, floors, and steps tracked across all of your trackers)

Examples

## Not run: 
get_lifetime_totals()

## End(Not run)

Minutes Fairly Active Time Series

Description

Resource path /activities/minutesFairlyActive

Usage

get_minutes_fairly_active(start_date, end_date)

Arguments

Value

A tibble with two columns: date and minutes_fairly_active

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_minutes_fairly_active(date)

## End(Not run)

Minutes Lightly Active Time Series

Description

Resource path /activities/minutesLightlyActive

Usage

get_minutes_lightly_active(start_date, end_date)

Arguments

Value

A tibble with two columns: date and minutes_lightly_active

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_minutes_lightly_active(date)

## End(Not run)

Minutes Sedentary Time Series

Description

Resource path /activities/minutesSedentary

Usage

get_minutes_sedentary(start_date, end_date)

Arguments

Value

A tibble with two columns: date and minutes_sedentary

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_minutes_sedentary(date)

## End(Not run)

Minutes Very Active Time Series

Description

Resource path /activities/minutesVeryActive

Usage

get_minutes_very_active(start_date, end_date)

Arguments

Value

A tibble with two columns: date and minutes_very_active

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_minutes_very_active(date)

## End(Not run)

Granular Sleep Stage Data

Description

Returns a tibble of nightly sleep stage data. Very granular. Returns blocks of time spent in each phase.

Usage

get_sleep_stage_granular(start_date, end_date = start_date)

Arguments

Value

A tibble of granular sleep stage data. This method is more granular than get_sleep_stage_summary, and returns blocks of time that you spent in each zone throughout the night.

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()

get_sleep_stage_granular(start_date, end_date)

## End(Not run)

Nightly Sleep Stage Summary Data

Description

Returns a tibble of nightly sleep stage data. Minutes in each stage, count of times in each stage, and a thirty day average for the number of minutes in each stage.

Usage

get_sleep_stage_summary(start_date, end_date = start_date)

Arguments

Value

A tibble of a variety of sleep stage summary data, by day

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()

get_sleep_stage_summary(start_date, end_date)

## End(Not run)

Nightly Sleep Summary

Description

Returns a tibble of summary by night

Usage

get_sleep_summary(start_date, end_date = start_date)

Arguments

Value

A tibble of a variety of sleep summary data by day

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()

get_sleep_summary(start_date, end_date)

## End(Not run)

Steps Time Series

Description

Resource path /activities/steps

Usage

get_steps(start_date, end_date)

Arguments

Value

A tibble with two columns: date and steps

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()
get_steps(date)

## End(Not run)

Get intraday steps time series

Description

See the API documentation for more detailed explanations of parameters and more usage information and examples.

Usage

get_steps_intraday(
  date = lubridate::today(),
  detail_level = c("1min", "5min", "15min"),
  start_time = NULL,
  end_time = NULL
)

Arguments

Value

A tibble with two columns: time and steps

See Also

Other intraday: get_active_zone_minutes_intraday(), get_calories_intraday(), get_distance_intraday(), get_elevation_intraday(), get_floors_intraday(), get_heart_rate_intraday()

Examples

## Not run: 
date <- lubridate::today()

## get minute by minute data
get_steps_intraday(detail_level = "15min")

## get more granular data
get_steps_intraday(detail_level = "1min")

## End(Not run)

Tracker Bests

Description

Retrieve tracker best distance, floors, and steps

Usage

get_tracker_bests()

Value

A tibble the best distance, floors, and steps (by date) tracked on your tracker

Examples

## Not run: 
get_tracker_bests()

## End(Not run)

Tracker Totals

Description

Retrieve tracker total distance, floors, and steps

Usage

get_tracker_totals()

Value

A tibble of all-time tracker totals (i.e. the total distance, floors, and steps tracked by your tracker)

Examples

## Not run: 
get_tracker_totals()

## End(Not run)

Perform a GET request

Description

Perform a GET request

Usage

perform_get(url, ...)

Arguments

Value

The response