[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/mlampros/fitbitviz/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","mlampros","reponame","fitbitviz","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-06-29T06:40:03.469642Z","description","Docker image for the Fitbit Visualizations","is_private","last_updated","2021-06-30T10:28:42.242129Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",100,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","\n[![tic](https://github.com/mlampros/fitbitViz/workflows/tic/badge.svg?branch=master)](https://github.com/mlampros/fitbitViz/actions)\n[![codecov.io](https://codecov.io/github/mlampros/fitbitViz/coverage.svg?branch=master)](https://codecov.io/github/mlampros/fitbitViz?branch=master)\n[![CRAN\\_Status\\_Badge](http://www.r-pkg.org/badges/version/fitbitViz)](http://cran.r-project.org/package=fitbitViz)\n[![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/fitbitViz?color=blue)](http://www.r-pkg.org/pkg/fitbitViz)\n $\"Buy$ \n[![](https://img.shields.io/docker/automated/mlampros/fitbitviz.svg)](https://hub.docker.com/r/mlampros/fitbitviz)\n[![Dependencies](https://tinyverse.netlify.com/badge/fitbitViz)](https://cran.r-project.org/package=fitbitViz)\n\n## fitbitViz\n\n
\n\nThe **fitbitViz** R package allows the extraction of data and the\nvisualization of *‘ggplot2’*, *‘Leaflet’* and *3-dimensionsal\n‘Rayshader’ Maps* using the [Fitbit Web\nAPI](https://dev.fitbit.com/build/reference/web-api/). If you own any of\nthe **Fitbit activity trackers** you can take advantage of this package.\nA detailed explanation of the functionality can be found both in the\nVignette and in the [blog\npost](http://mlampros.github.io/2021/05/20/fitbitViz_package/).\n\nThe 3-dimensional Rayshader Map requires the installation of the\n[CopernicusDEM](https://github.com/mlampros/CopernicusDEM) R package\nwhich includes the **30- and 90-meter elevation data**.\n\n
\n\n### Requirements:\n\n
\n\nTo make use of this R package you have first to **register an\nApplication** in . By registering an\napplication you will receive the Fitbit **token** which besides your\nexisting\n[user-id](https://community.fitbit.com/t5/Web-API-Development/Where-do-I-find-my-User-ID/m-p/1138667/highlight/true#M4375)\nis required so that you can take advantage of the **fitbitViz**\nfunctions.\n\nThere are many resources on the web on how to setup a Fitbit\napplication. I modified the following\n[guide](https://obrl-soil.github.io/fitbit-api-r/) which explains in\ndetail how to register an application and then receive a token to\nretrieve the Fitbit data for a specific time period (maximum a year).\nThe next images and comments explain the whole process,\n\n- Go to and click on **Manage > Register\n an App**\n\n **Login with your Fitbit credentials** and follow the prompts. I\n used as URL in the Registration Page **my Fitbit user-id** url,\n **`https://www.fitbit.com/user/USER_ID`**. You have to replace the\n **USER\\_ID** in the url with [your specific\n user-id](https://community.fitbit.com/t5/Web-API-Development/Where-do-I-find-my-User-ID/m-p/1138667/highlight/true#M4375).\n Then in the **Redirect URL** field use **`https://localhost`**. Tick\n the remaining options as in the next image, *read and agree to the\n terms of service* and click **Register** to register the\n application.\n\n ![](./man/figures/register_application.png)\n\n- Once the app is created, click on the ‘OAuth 2.0 tutorial page’\n weblink near the bottom of the screen:\n\n ![](./man/figures/application_registered.png)\n\n- Scroll down to the end of **1. Authorize** and **right click** on\n the provided **authorization URL** (in blue color) to open this URL\n on a new web browser tab which will show the Fitbit authorization\n interface. Change the auth period to **1 year** so that you don’t\n have to go through this too often and tick all options before\n clicking *Allow* (you will probably play with the other endpoints at\n some point in the future)\n\n ![](./man/figures/one_year_long.png)\n\n- After clicking *Allow*, the browser tab redirects to the callback\n URL. You’ll have to **copy and paste the full URL** which now\n includes also the **access token** to the **2. Parse response**\n header of the previous tab (where we have seen also the *1.\n Authorize* section). The required **access token** for your\n application that you can use in this package will appear below the\n text box (it’s a long string of characters).\n\n
\n\nYou now have your **token** and can start using the **fitbitViz** R\npackage to access and visualize your data.\n\n
\n\n### Keep track of your activities using ‘fitbitViz’, ‘Blogdown’ and ‘Github Actions’\n\n
\n\nThe functions of the **fitbitViz** R package can be used in an automatic\nway so that the user can keep track of the **Visualizations** and\n**data** over time.\n\nFrom the first moment I’ve started implementing the **fitbitViz** R\npackage this is what I actually had in my mind. You can have a look to\n[my Fitbit Visualizations\nwebsite](https://mlampros.github.io/fitbitVizBlog/). The following steps\nexplain in detail how this can be achieved:\n\n- Fork the [fitbitVizBlog](https://github.com/mlampros/fitbitVizBlog)\n repository ( **!!! Not this repository but the one that includes the\n blog posts !!!** )\n- Create the following **secrets** required for the\n [.github/workflows/gh\\_fitbit\\_blog.yaml](https://github.com/mlampros/fitbitVizBlog/blob/master/.github/workflows/gh_fitbit_blog.yaml)\n file by navigating to **Settings** >> **secrets** (*be aware\n that the **AWS\\_ACCESS\\_KEY\\_ID** and **AWS\\_SECRET\\_ACCESS\\_KEY**\n are optional and required only if you want to receive the\n **3-dimensional** Rayshader Visualization*)\n - **USER\\_ID**: click on ‘New repository secret’ and use\n **USER\\_ID** as **Name** and your Fitbit\n [user-id](https://community.fitbit.com/t5/Web-API-Development/Where-do-I-find-my-User-ID/m-p/1138667/highlight/true#M4375)\n as **Value**\n - **FITBIT\\_TOKEN**: click on ‘New repository secret’ and use\n **FITBIT\\_TOKEN** as **Name** and the **token** you received\n from your previously registered Fitbit application as **Value**\n - **GH\\_PAT**: First create a [Personal Access\n Token](https://github.com/settings/tokens) by giving as **Note**\n a name and then ticking in **Select scopes** the **workflow**\n (Update GitHub Action workflows) scope and lastly click on\n **Generate Token**. Then click on ‘New repository secret’ and\n use **GH\\_PAT** as **Name** and the copied **Generated Token**\n as **Value**\n - **EMAIL**: click on ‘New repository secret’ and use **EMAIL** as\n **Name** and the **e-mail** you use on Github as **Value**\n - **AWS\\_ACCESS\\_KEY\\_ID**: click on ‘New repository secret’ and\n use **AWS\\_ACCESS\\_KEY\\_ID** as **Name** and insert your **aws\n access key id** in the **Value** field ( the aws credentials are\n required for the Copernicus Elevation Data, this [guide explains\n how to receive the aws\n credentials](https://supsystic.com/documentation/id-secret-access-key-amazon-s3/)\n )\n - **AWS\\_SECRET\\_ACCESS\\_KEY**: click on ‘New repository secret’\n and use **AWS\\_SECRET\\_ACCESS\\_KEY** as **Name** and insert your\n **aws secret access key** in the **Value** field\n\nWhat it remains is to modify the\n[.github/workflows/gh\\_fitbit\\_blog.yaml](https://github.com/mlampros/fitbitVizBlog/blob/master/.github/workflows/gh_fitbit_blog.yaml)\nfile to adjust the\n\n- current **cron-job** settings which runs every Sunday at 23:00 pm\n - ![](./man/figures/cron_job_setup.png)\n- current **fitbitViz** parameters\n - ![](./man/figures/fitbit_parameters.png)\n\nRegarding the **fitbitViz** parameters\n([.github/workflows/gh\\_fitbit\\_blog.yaml](https://github.com/mlampros/fitbitVizBlog/blob/master/.github/workflows/gh_fitbit_blog.yaml)\nfile) at it’s current state the application takes:\n\n- **DATE**: this parameter corresponds to the current Date ( the Date\n that the **Cron-Job** runs ). You can set this parameter also to a\n character string such as **DATE=“2021-05-16”;** if you want to use\n as the end Date this specific date. **Be Aware** this parameter is\n defined in a separate github action step.\n- **previous\\_n\\_days**: this parameter specifies the number of days\n before the current **DATE** for which the Fitbit data will be\n downloaded (I’ve set it to **6** to visualize and access data of the\n **last** week)\n- **sleep\\_time\\_begins**: this is your scheduled sleep time in form\n of a **lubridate::hms(“00H 40M 0S”)** object (adjust the input\n depending on your sleep time)\n- **sleep\\_time\\_ends**: this is your scheduled wake up time in form\n of a **lubridate::hms(“08H 00M 0S”)** object (adjust the input\n depending on your wake up time)\n- **asc\\_desc\\_linestring**: this parameter is related to the GPS data\n of the **3-dimensional** map especially if you keep track of your\n outdoor activities. There are **3 options** but before making use of\n the **2nd. option make sure** that there is an ascending and\n descending route, otherwise it will give an error:\n 1. by specifying **asc\\_desc\\_linestring=\"\";** a single LINESTRING\n will be created based on the GPS data using a single color\n 2. by specifying **asc\\_desc\\_linestring=“TRUE”;** the LINESTRING\n of the GPS data will be split into 2 parts using the highest\n elevation location as a split point (**blue** color for the\n ascending part and **red** color for the descending part)\n 3. by specifying **asc\\_desc\\_linestring=“17H 5M 0S”;** the GPS\n data will be split into 2 parts using this input time as split\n point (adjust the time based on your data)\n- **time\\_zone**: your current time zone as specified in\n **lubridate::ymd\\_hms(tz = ..)** function (it defaults to my current\n time zone which is **Europe/Athens**)\n- **buffer\\_meters**: this parameter extends the 3-dimensional map by\n **N-meters** (the current default value is **1500** meters)\n- **resolution\\_dem**: this parameter takes either **30** or **90**\n and corresponds to the resolution of the Copernicus elevation data\n (the current default value is **30** meters)\n- **verbose\\_Rmd**: this last parameter is just for debugging in case\n you want to enable verbosity in the output **.Rmd** file (it\n defaults to “FALSE” and it takes also “TRUE” as input)\n\n
\n\nThe order to *modify*, *debug* or *include new code / functions* to the\nfiles of this Github Repository is the following:\n\n- first modify the **gh\\_fitbit\\_blog.yaml** file\n- then modify the *R code* of the **R\\_templates/data\\_template.R**\n file\n- and finally modify the *Rmd code* of the\n **R\\_templates/functions\\_template.Rmd** file\n\n
\n\nOne **important** thing to keep in mind is that besides the\nVisualizations the user has access also to the pre-processed Fitbit data\nby clicking to a **CSV** button as shown in the next image,\n\n
\n\n![](./man/figures/csv_button.png)\n\n
\n\n- **References**:\n - \n - \n - \n - \n - \n\n
\n\n### Docker Image:\n\n
\n\n**Docker images** of the *fitbitViz* package are available to download\nfrom my [dockerhub](https://hub.docker.com/r/mlampros/fitbitviz)\naccount. The images come with *Rstudio* and the *R-development* version\n(latest) installed. The whole process was tested on Ubuntu 18.04. To\n**pull** & **run** the image do the following,\n\n
\n\n``` r\ndocker pull mlampros/fitbitviz:rstudiodev\n\ndocker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 mlampros/fitbitviz:rstudiodev\n```\n\n
\n\nThe user can also **bind** a home directory / folder to the image to use\nits files by specifying the **-v** command,\n\n
\n\n``` r\ndocker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 -v /home/YOUR_DIR:/home/rstudio/YOUR_DIR mlampros/fitbitviz:rstudiodev\n\n```\n\n
\n\nIn the latter case you might have first give permission privileges for\nwrite access to **YOUR\\_DIR** directory (not necessarily) using,\n\n
\n\n``` r\nchmod -R 777 /home/YOUR_DIR\n\n```\n\n
\n\nThe **USER** defaults to *rstudio* but you have to give your\n**PASSWORD** of preference (see\n[www.rocker-project.org](https://www.rocker-project.org/) for more\ninformation).\n\n
\n\nOpen your web-browser and depending where the docker image was *build /\nrun* give,\n\n
\n\n**1st. Option** on your personal computer,\n\n
\n\n``` r\nhttp://0.0.0.0:8787 \n```\n\n
\n\n**2nd. Option** on a cloud instance,\n\n
\n\n``` r\nhttp://Public DNS:8787\n```\n\n
\n\nto access the Rstudio console in order to give your username and\npassword.\n\n
\n\n### Package Installation & Citation:\n\n
\n\nTo install the package from CRAN use,\n\n``` r\ninstall.packages(\"fitbitViz\")\n```\n\n
\n\nand to download the latest version of the package from Github,\n\n``` r\nremotes::install_github('mlampros/fitbitViz')\n```\n\n
\n\nIf you use the **fitbitViz** R package in your paper or research please\ncite `https://CRAN.R-project.org/package=fitbitViz`:\n\n
\n\n``` r\n@Manual{,\n title = {{fitbitViz}: Fitbit Visualizations},\n author = {Lampros Mouselimis},\n year = {2021},\n note = {R package version 1.0.0},\n url = {https://CRAN.R-project.org/package=fitbitViz},\n}\n```\n\n
\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",4114937488,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",8447072,"full_size",2071745945,"id",156131760,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:1147547e23a5fe6cc4dacb24e158d647050bbe18f3bfb21e41dbfdf470cf77e9","features","","last_pulled","2026-10-03T19:43:04.371478927Z","last_pushed","2021-06-30T10:28:42Z","os","linux","os_features","os_version","size","variant","2021-06-30T10:28:41.94796Z","last_updater","last_updater_username","media_type","rstudiodev","repository",14779330,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

mlampros/fitbitviz

Tags for mlampros/fitbitviz