https://github.com/CredibilityLab/groundhog

Reproducible R Scripts Via Date Controlled Installing & Loading of CRAN & Git Packages
https://github.com/CredibilityLab/groundhog

cran r r-package reproducible-research rstats

Last synced: 3 months ago
JSON representation

Reproducible R Scripts Via Date Controlled Installing & Loading of CRAN & Git Packages

• Host: GitHub
• URL: https://github.com/CredibilityLab/groundhog
• Owner: CredibilityLab
• License: gpl-3.0
• Created: 2020-03-10T10:44:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T12:15:18.000Z (4 months ago)
• Last Synced: 2024-07-12T14:06:42.733Z (4 months ago)
• Topics: cran, r, r-package, reproducible-research, rstats
• Language: R
• Homepage: https://groundhogr.com/
• Size: 57.7 MB
• Stars: 77
• Watchers: 8
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - CredibilityLab/groundhog - Reproducible R Scripts Via Date Controlled Installing & Loading of CRAN & Git Packages (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%",

  eval = FALSE

)

```

# groundhog

[![CRAN version](https://www.r-pkg.org/badges/version-ago/groundhog)](https://cran.r-project.org/package=groundhog)

[![R build status](https://github.com/CredibilityLab/groundhog/workflows/R-CMD-check/badge.svg)](https://github.com/CredibilityLab/groundhog/actions)

[![Codecov test coverage](https://codecov.io/gh/CredibilityLab/groundhog/branch/master/graph/badge.svg)](https://codecov.io/gh/CredibilityLab/groundhog?branch=master)

## Installation

groundhog has not yet been released on CRAN and must be installed from our

custom repository:

```{r}

install.packages("groundhog", repos = "https://cran.groundhogr.com")

```

## Example 1 - Recovering broken code with backwards incompatible change in dplyr

With version 0.5, [dplyr](https://dplyr.tidyverse.org/) changed how the

[`distinct`](https://dplyr.tidyverse.org/reference/distinct.html) function

worked, leading to dropped variables:

Say you have data with repeat values of `x`:

```{r}

df1 <- data.frame(

  x1 = c(1, 1, 2),

  x2 = c("a", "b", "c")

)

```

To drop repeated rows you can use the package dplyr and run:

```{r}

dplyr::distinct(df1, x1) 

```

The problem is that in June 2016, the function

[`dplyr::distinct()`](https://dplyr.tidyverse.org/reference/distinct.html) was

modified in a non backwards-compatible way. Up to that date it would keep all

variables but, afterward the SAME function drops all other variables, The same

line of code, run in the same computer, on the same date, has one effect before

june 2016 vs after.

With groundhog the script tells us which version of dplyr to use keeping the

same results:

```{r eval = FALSE}

library(groundhog)

# if before the change, then both variables are kept

groundhog.library("dplyr", date = "2016-06-22")

```

```{r, include = FALSE, echo = FALSE, plot = FALSE}

library(groundhog)

groundhog.library("dplyr", date = "2016-06-22", ignore.package.conflicts = TRUE)

```

```{r}

distinct(df1, x1) 

```

```{r}

# if after the change, only x1 is kept

#Now as it was two days after 

#IMPORTANT: since another version of dplyr is loaded, we do CTRL-SHIFT-F10 to restart the R Session and load the newer version

groundhog.library("dplyr",date = "2016-06-26")

distinct(df1, x1) 

```