pegeler / eddington2

Calculating your Eddington Number for Cycling 🚲📈

Disclaimer

Comments and posts on this site are my own and do not necessarily reflect the views of my employer or any organization of which I am a member.

eddington2's Issues

Tests must be written before merging R6 branch into master.

delete

ignore

Why R >=4.3?

The minimum R >=4.3.0 is unusual. Why is it necessary?

R6 Eddington class cannot be saved without data loss.

The hash map of ride history is just a pointer (Rcpp::XPtr) to a std::unordered_map. So if a user attempts to save the Eddington class using save() or saveRDS(), they will be disappointed when reloading data since the pointer will be nil and the data will be lost.

This means that in current-state, several functions will not work as intended when attempting to manipulate the same object between sessions. Some will error silently (like the update() method) and others will raise an error (like attempting to access the H active field).

Add serialize/deserialize to R's EddingtonModule

Related to #3

Clone method in R6 Eddington class causes undesired behavior

Using the clone() or clone(deep = TRUE) method will result in the internal hashmap pointing to the same memory address. Therefore, changes made to any of these objects will propagate to others.

# Random data
rides <- rgamma(15, shape = 2, scale = 10)

# Make shallow and deep clones
e <- Eddington$new(rides)
e$H
##   ride_length ride_count
## 1          11          1
## 2          12          2
## 3          13          1
## 4          16          2
## 5          19          1
## 6          36          1
## 7          37          1
## 8          47          1

foo <- e$clone()
bar <- e$clone(TRUE)

# See that the pointer for each hashmap is the same
e$.__enclos_env__$private$.H
## <pointer: 0x0123456789ab>
foo$.__enclos_env__$private$.H
## <pointer: 0x0123456789ab>
bar$.__enclos_env__$private$.H
## <pointer: 0x0123456789ab>

# Update data in 'e' ONLY
e$update(rep(50,50))

# Hashmap has been updated for clones as well
e$H
## [1] ride_length ride_count 
## <0 rows> (or 0-length row.names)
foo$H
## [1] ride_length ride_count 
## <0 rows> (or 0-length row.names)
bar$H
## [1] ride_length ride_count 
## <0 rows> (or 0-length row.names)