README.md

In eddington: Compute a Cyclist's Eddington Number

eddington

One statistic that cyclists are known to track is their Eddington number. The Eddington number for cycling, E, is the maximum number where a cyclist has ridden E miles on E distinct days. So to get a number of 30, you need to have ridden 30 miles or more on 30 separate days.

This package provides functions to compute a cyclist’s Eddington number, including efficiently computing cumulative E over a vector. These functions may also be used for h-indices for authors. Both are specific applications of computing the side length of a Durfee square.

The package can also be used to ingest GPS Exchange Format (GPX) files into a data.frame format conducive to computing the Eddington number.

Installation

You can install the released version of eddington from CRAN with:

install.packages("eddington")

And the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("pegeler/eddington2/R/package")

Example

Here is a basic example showing how to get the summary Eddington number of the included simulated rides dataset. Note that we first have to aggregate ride mileage by date.

library(eddington)
library(dplyr)

rides %>%
  group_by(ride_date) %>%
  summarize(n = n(), total = sum(ride_length)) %>% 
  summarize(E = E_num(total)) %>% 
  pull
#> [1] 29

See the package vignette for detailed usage.

eddington documentation built on Sept. 11, 2024, 5:30 p.m.