Skip to content

Latest commit

 

History

History
89 lines (69 loc) · 3.91 KB

README.md

File metadata and controls

89 lines (69 loc) · 3.91 KB
Raw

relic: objects from history

Lifecycle: experimental R-CMD-check codecov relic on R-Universe

And deeper than oblivion we do bury
The incensing relics of it
William Shakespeare, All’s Well That Ends Well, V.3

The relic package provides tools for working with version-controlled workflows, in git repositories. It enables extracting and comparing files and objects from project history. You can use relic for tasks such as

  • Pulling a file from a previous version of your code
  • Creating a report (or a GIF!) that shows the evolution of a model object or output over the course of repository development
  • Run code repeatedly at many points along repository history to compare outputs or performance.

relic has specific functionality for working with targets projects. It works especially well when used in conjunction with cloud-based, versioned object storage.

Installation

You can install the development version of relic from R-Universe like so:

install.packages("relic", repos = "https://ecohealthalliance.r-universe.dev")

Or, you can build the source package from GitHub with

devtools::install_github("ecohealthalliance/relic")

Related work

  • git2r is a low-level R interface to git, and is used by relic.
  • gert is an alternative, higher-level R interface to git especially suited to performing and automating git operations.
  • gittargets is an R package for versioning objects in the targets framework by placing binary objects in a separate git or Git LFS repository.
  • git2rdata is an R package for organizing tabular data to store in git repositories.
  • git2net is a Python package that facilitates network analysis of git repositories.
  • bisectr is an R package for running git bisect to find commits that introduced bugs in project history.
  • dolt is a relational database with git-like versioning and doltr is an R interface to it.

Find more related packages on R-Universe.

Code of Conduct

Please note that the relic project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

relic is developed at EcoHealth Alliance.

Created by EcoHealth Alliance