https://github.com/teramonagi/fitbitr
Interact with Fitbit data in R using Fitbit API
https://github.com/teramonagi/fitbitr
fitbit-api fitbit-data r r-package
Last synced: 8 months ago
JSON representation
Interact with Fitbit data in R using Fitbit API
- Host: GitHub
- URL: https://github.com/teramonagi/fitbitr
- Owner: teramonagi
- License: mit
- Created: 2016-03-30T21:55:01.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-09-15T00:31:07.000Z (almost 4 years ago)
- Last Synced: 2025-10-13T17:55:33.807Z (9 months ago)
- Topics: fitbit-api, fitbit-data, r, r-package
- Language: R
- Homepage:
- Size: 306 KB
- Stars: 51
- Watchers: 10
- Forks: 35
- Open Issues: 11
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
fig.width=8,
fig.height=4,
cache=TRUE
)
```
# fitbitr
[](http://cran.rstudio.com/web/packages/fitbitr)
`fitbitr` package allows users to interact with Fitbit data in R using Fitbit API.
This package allows for most of the read and write methods that you might want to use.
## Installation
fitbitr isn't available from CRAN yet, but you can get it from github with:
```{r, eval=FALSE}
# install.packages("devtools")
devtools::install_github("teramonagi/fitbitr")
```
## Preparation
### API key
To get your own token (API key), you have to register your own application in [here](https://dev.fitbit.com/apps/new).
For your reference, we share our setting:
After registration, you can get your own `FITBIT_KEY` and `FITBIT_SECRET` (referred to as **OAuth 2.0 Client ID** and **Client Secret** in the next figure).
If you set the following variables as a global variable, this package will use these values for API key.
```{r, eval=FALSE}
# As a global variable
FITBIT_KEY <- ""
FITBIT_SECRET <- ""
# If you want, Default: "http://localhost:1410/"
# FITBIT_CALLBACK <- ""
```
Or, you can set these values as a environment variable
```{r, eval=FALSE}
Sys.setenv(FITBIT_KEY = "", FITBIT_SECRET = "")
```
### Load libraries
```{r}
library("fitbitr")
library("ggplot2") # for visualization in this document
```
### Get Fitbit API token
You can get your Fitbit toekn using `fitbitr::oauth_token()`:
```{r, eval=FALSE}
# Get token
token <- fitbitr::oauth_token()
# Get token
token <- fitbitr::oauth_token(language="en_US")
# Get token
token <- fitbitr::oauth_token(language="en_GB")
```
This function open a web browser autmatically and return Fitbit token.
```{r, echo=FALSE, cache=FALSE}
#Adhoc to build this document on my PC...
#saveRDS(token, "temp_token")
token <- readRDS("temp_token")
```
## How to use
### Activity
```{r}
# Example date
date <- "2017-12-29"
# Get daily activity summary
str(get_activity_summary(token, date))
# Get Activity Time Series
get_activity_time_series(token, "distance", date=date, period="7d")
# Get activity intraday time series
# You have to use a **personal** key and secret.
df <- get_activity_intraday_time_series(token, "steps", date, detail_level="15min")
df$time <- as.POSIXct(strptime(paste0(df$dateTime, " ", df$dataset_time), "%Y-%m-%d %H:%M:%S"))
ggplot2::ggplot(df, aes(x=time, y=dataset_value)) + geom_line()
# Get Activity Types (complicated nested list)
length(get_activity_types(token))
# Get Activity Type (Yoga=52001)
get_activity_type(token, 52001)
# Get Frequent Activities
get_frequent_activities(token)
# Get Recent Activities
get_recent_activity_types(token)
# Add, get and delete favorite activities
add_favorite_activity(token, 52001)
get_favorite_activities(token)
delete_favorite_activity(token, 52001)
get_favorite_activities(token)
get_activity_goals(token, period="daily")
update_activity_goals(token, period="daily", distance=11.3)
get_activity_goals(token, period="daily")
get_activity_goals(token, period="weekly")
update_activity_goals(token, period="weekly", steps="100000")
get_activity_goals(token, period="weekly")
# Get Lifetime Stats
get_lifetime_stats(token)
```
You can find more details in [here](https://dev.fitbit.com/docs/activity/)
### Heart Rate
```{r}
# Set a date for example
date <- "2017-12-25"
# Get heart rate time series
df <- get_heart_rate_time_series(token, date=date, period="7d")
ggplot(df, aes(x=date, y=peak_max)) + geom_line()
# Get intraday heart rate time series
df <- get_heart_rate_intraday_time_series(token, date=date, detail_level="15min")
df$time <- as.POSIXct(paste0(date, " ", df$time))
ggplot(df, aes(x=time, y=value)) + geom_line()
```
You can find more details [here](https://dev.fitbit.com/docs/heart-rate/).
### Sleep
```{r}
# Get Sleep Logs(date is character or Date)
x <- get_sleep_logs(token, "2016-03-30")
print(head(x$sleep))
x$summary
#Get the current sleep goal.
get_sleep_goal(token)
#Update sleep goal
update_sleep_goal(token, 380)
#Get Sleep Time Series
get_sleep_time_series(token, "timeInBed", date="2016-04-02", period="7d")
get_sleep_time_series(token, "efficiency", base_date="2016-03-30", end_date="2016-03-30")
#Log sleep
log <- log_sleep(token, "22:00", 180, date="2010-04-18")
print(head(log))
#Delete sleep log
delete_sleep_log(token, log$logId)
```
You can find more details [here](https://dev.fitbit.com/docs/sleep/).
### Devices
```{r}
# Get deice information you registerd
get_devices(token)
```
```{r}
# Add alarms
tracker_id <- get_devices(token)$id[1]
add_alarm(token, tracker_id, "07:15-08:00", "MONDAY")
alarm <- get_alarms(token, tracker_id)
alarm
```
```{r}
# Update the content alarm
alarm_id <- tail(alarm, 1)$alarmId
update_alarm(token, tracker_id, alarm_id, "02:15-03:00", "FRIDAY")
get_alarms(token, tracker_id)
```
```{r}
# Delete alarm you registered here
delete_alarm(token, tracker_id, alarm_id)
get_alarms(token, tracker_id)
```
You can find more details [here](https://dev.fitbit.com/docs/devices/).
## Contributing
- Fork it ( https://github.com/teramonagi/fitbitr/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
## Acknowledgements
Many thanks to Mr.dichika since This package is based on the extension of [myFitbit package](https://github.com/dichika/myFitbit).