jonocarroll / runkeepr

Extract, plot, and analyse Runkeeper(TM) data.

runkeepR

Extract, plot, and analyse Runkeeper(TM) data.

Installation:

Assuming the TravisCI badges above are green (i.e. the current build is stable) this package can be installed via

devtools::install_github("jonocarroll/runkeepR")

or

pacman::p_load_gh("jonocarroll/runkeepR")

Usage

load the installed package

library(runkeepR)

You can get a zipped export of your Runkeeper(TM) data from the logged-in settings page on Runkeeper's website, e.g. runkeeper-data-export-12517482-2016-05-20-1550.zip.

Save the .zip file to a directory (e.g. ~/runkeepR-test/) and unzip the contents (mainly .gpx files and a couple of .csv files). Set this directory as your working directory in R.

setwd("~/runkeepR-test/") ## set directory to location of .gpx files

Loading and processing the route information contained in the .gpx and .csv files into a data.frame is as simple as

routes <- load_tracks(".")
save(routes, file="saved_routes.rds") ## save the data to avoid re-processing

The data can be plotted either with ggplot

load("saved_routes.rds")
plot_ggplot(routes, center="Adelaide, Australia", zoom=14)

or leaflet; this plots all paths but is clever about which ones to load depending on the current viewport, so it's faster.

load("saved_routes.rds")
plot_leaflet(routes)

Summary statistics can be viewed

summarise_runs(routes, dashboard=FALSE)

and presented in a shinydashboard

summarise_runs(routes)

summarised either monthly

or daily

Not affiliated with Runkeeper(TM). Runkeeper(TM) logo © FitnessKeeper 2016

runkeepr's Issues

Use safer functions

Implement vapply() over sapply() ; http://stackoverflow.com/questions/12339650/why-is-vapply-safer-than-sapply

Also check for any other unsafe functions.

I think I'm already using standard evaluation versions of dplyr and tidyr functions (e.g. gather_, mutate_).

Add examples to run explicitly

Use proper examples and run them. These will also get picked up by check() and run.

Dispatch plot

Extend plot for custom class. Add a 'type' variable to select between ggplot2 and leaflet.

Implement more automated testing

I'm already using check() and test() but there could be more;

Add lintr checks. It's possible to add an automated test:

if (requireNamespace("lintr", quietly = TRUE)) {
  context("lints")
  test_that("Package Style", {
    lintr::expect_lint_free()
  })
}

Add covr checks. Still not 100% sure what this analyses though.

Error loading in routes

Hello,

I'm very very new to R, but have managed to get this package installed. Trying to load in routes just errors.

> getwd()
[1] "/Users/dm/scratch/runkeeper"
> library(runkeepR)
routes <- load_tracks(".")
Error in class(xx) <- cl : attempt to set an attribute on NULL

That's as far as I get, the files definitely exist at the location and there are no permission issues there. Makes no difference if I give the full path name to load_tracks either.

Is there an issue with the package, or do I need to learn a lot more R before I can use it?

Error: GeomRasterAnn was built with an incompatible version of ggproto.

plot_ggplot(routes, center="Munich, Germany", zoom=14)

Error: GeomRasterAnn was built with an incompatible version of ggproto.
Please reinstall the package that provides this extension.