relic
Tools for working with version-controlled data science workflows
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (19.7%) to scientific vocabulary
Last synced: 7 months ago
·
JSON representation
·
Repository
Tools for working with version-controlled data science workflows
Basic Info
Statistics
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 14
- Releases: 0
Created over 2 years ago
· Last pushed 12 months ago
Metadata Files
Readme
Changelog
Contributing
License
Code of conduct
Citation
Codemeta
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# relic: objects from history
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/ecohealthalliance/relic/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/ecohealthalliance/relic)
[](https://ecohealthalliance.r-universe.dev/relic)
> _And deeper than oblivion we do bury_
> _The incensing relics of it_
> William Shakespeare, [All's Well That Ends Well, V.3](https://internetshakespeare.uvic.ca/doc/AWW_M/scene/5.3/index.html)
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`](https://books.ropensci.org/targets-manual) projects. It works
especially well when used in conjunction with [cloud-based, versioned object storage](https://books.ropensci.org/targets/cloud-storage.html).
## Installation
You can install the development version of `relic` from R-Universe like so:
```r
install.packages("relic", repos = "https://ecohealthalliance.r-universe.dev")
```
Or, you can build the source package from GitHub with
```r
devtools::install_github("ecohealthalliance/relic")
```
## Related work
- [`git2r`](https://github.com/ropensci/git2r) is a low-level R interface to git, and is used by `relic`.
- [`gert`](https://github.com/r-lib/gert) is an alternative, higher-level R interface to git especially suited to performing and automating git operations.
- [`gittargets`](https://github.com/ropensci/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`](https://github.com/ropensci/git2rdata/) is an R package for organizing tabular data to store in git repositories.
- [`git2net`](https://github.com/gotec/git2net) is a Python package that facilitates network analysis of git repositories.
- [`bisectr`](https://github.com/wch/bisectr) is an R package for running `git bisect` to find commits that introduced bugs in project history.
- [`dolt`](https:://dolthub.com) is a relational database with git-like versioning and [doltr](https:://github.com/ecohealthalliance/doltr) is an R interface to it.
Find more related packages on [R-Universe](https://r-universe.dev/search/?q=git).
## Code of Conduct
Please note that the relic project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
`relic` is developed at [EcoHealth Alliance](https://www.ecohealthalliance.org/).
[](https://www.ecohealthalliance.org/)
Owner
- Name: EcoHealth Alliance
- Login: ecohealthalliance
- Kind: organization
- Email: tech@ecohealthalliance.org
- Location: New York, NY
- Website: http://ecohealthalliance.org/
- Repositories: 199
- Profile: https://github.com/ecohealthalliance
Citation (CITATION.cff)
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
cff-version: 1.2.0
message: 'To cite package "relic" in publications use:'
type: software
license: MIT
title: 'relic: Objects from History'
version: 0.1.0.9000
abstract: Tools working with the history of version-controlled projects,
authors:
- family-names: Ross
given-names: Noam
email: ross@ecohealthalliance.org
orcid: https://orcid.org/0000-0002-2136-0000
preferred-citation:
type: manual
title: 'relic: Tools for working with version-controlled data science workflows'
authors:
- family-names: Ross
given-names: Noam
email: ross@ecohealthalliance.org
orcid: https://orcid.org/0000-0002-2136-0000
year: '2024'
edition: 0.1.0
url: https://github.com/ecohealthalliance/relic
repository-code: https://github.com/ecohealthalliance/relic
url: https://ecohealthalliance.github.io/relic
contact:
- family-names: Ross
given-names: Noam
email: ross@ecohealthalliance.org
orcid: https://orcid.org/0000-0002-2136-0000
references:
- type: software
title: git2r
abstract: 'git2r: Provides Access to Git Repositories'
notes: Imports
url: https://docs.ropensci.org/git2r/
repository: https://ropensci.r-universe.dev
authors:
- family-names: file.
given-names: See AUTHORS
year: '2023'
- type: software
title: fs
abstract: 'fs: Cross-Platform File System Operations Based on ''libuv'''
notes: Imports
url: https://fs.r-lib.org
repository: https://CRAN.R-project.org/package=fs
authors:
- family-names: Hester
given-names: Jim
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
- family-names: Csárdi
given-names: Gábor
email: csardi.gabor@gmail.com
year: '2023'
- type: software
title: rlang
abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features'
notes: Imports
url: https://rlang.r-lib.org
repository: https://CRAN.R-project.org/package=rlang
authors:
- family-names: Henry
given-names: Lionel
email: lionel@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2023'
- type: software
title: igraph
abstract: 'igraph: Network Analysis and Visualization'
notes: Suggests
url: https://r.igraph.org/
repository: https://CRAN.R-project.org/package=igraph
authors:
- family-names: Csárdi
given-names: Gábor
email: csardi.gabor@gmail.com
orcid: https://orcid.org/0000-0001-7098-9676
- family-names: Nepusz
given-names: Tamás
email: ntamas@gmail.com
orcid: https://orcid.org/0000-0002-1451-338X
- family-names: Traag
given-names: Vincent
orcid: https://orcid.org/0000-0003-3170-3879
- family-names: Horvát
given-names: Szabolcs
email: szhorvat@gmail.com
orcid: https://orcid.org/0000-0002-3100-523X
- family-names: Zanini
given-names: Fabio
email: fabio.zanini@unsw.edu.au
orcid: https://orcid.org/0000-0001-7097-8539
- family-names: Noom
given-names: Daniel
- family-names: Müller
given-names: Kirill
email: kirill@cynkra.com
orcid: https://orcid.org/0000-0002-1416-3412
year: '2023'
- type: software
title: knitr
abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
notes: Suggests
url: https://yihui.org/knitr/
repository: https://CRAN.R-project.org/package=knitr
authors:
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
year: '2023'
- type: software
title: rmarkdown
abstract: 'rmarkdown: Dynamic Documents for R'
notes: Suggests
url: https://pkgs.rstudio.com/rmarkdown/
repository: https://CRAN.R-project.org/package=rmarkdown
authors:
- family-names: Allaire
given-names: JJ
email: jj@posit.co
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
- family-names: Dervieux
given-names: Christophe
email: cderv@posit.co
orcid: https://orcid.org/0000-0003-4474-2498
- family-names: McPherson
given-names: Jonathan
email: jonathan@posit.co
- family-names: Luraschi
given-names: Javier
- family-names: Ushey
given-names: Kevin
email: kevin@posit.co
- family-names: Atkins
given-names: Aron
email: aron@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
- family-names: Cheng
given-names: Joe
email: joe@posit.co
- family-names: Chang
given-names: Winston
email: winston@posit.co
- family-names: Iannone
given-names: Richard
email: rich@posit.co
orcid: https://orcid.org/0000-0003-3925-190X
year: '2023'
- type: software
title: targets
abstract: 'targets: Dynamic Function-Oriented ''Make''-Like Declarative Pipelines'
notes: Suggests
url: https://docs.ropensci.org/targets/
repository: https://ropensci.r-universe.dev
authors:
- family-names: Landau
given-names: William Michael
email: will.landau.oss@gmail.com
orcid: https://orcid.org/0000-0003-1878-3253
year: '2023'
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
notes: Suggests
url: https://testthat.r-lib.org
repository: https://CRAN.R-project.org/package=testthat
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2023'
version: '>= 3.0.0'
- type: software
title: devtag
abstract: 'devtag: Restrict Help Files to Development'
notes: Suggests
url: https://github.com/moodymudskipper/devtag
authors:
- family-names: Fabri
given-names: Antoine
email: antoine.fabri@example.com
year: '2023'
- type: software
title: pkgcheck
abstract: 'pkgcheck: rOpenSci Package Checks'
notes: Suggests
url: https://docs.ropensci.org/pkgcheck/
repository: https://ropensci-review-tools.r-universe.dev
authors:
- family-names: Padgham
given-names: Mark
email: mark.padgham@email.com
orcid: https://orcid.org/0000-0003-2172-5265
- family-names: Salmon
given-names: Maëlle
- family-names: Wujciak-Jens
given-names: Jacob
email: jacob@wujciak.de
orcid: https://orcid.org/0000-0002-7281-3989
year: '2023'
- type: software
title: lintr
abstract: 'lintr: A ''Linter'' for R Code'
notes: Suggests
url: https://lintr.r-lib.org
repository: https://CRAN.R-project.org/package=lintr
authors:
- family-names: Hester
given-names: Jim
email: james.f.hester@gmail.com
- family-names: Angly
given-names: Florent
- family-names: Hyde
given-names: Russ
- family-names: Chirico
given-names: Michael
- family-names: Ren
given-names: Kun
- family-names: Rosenstock
given-names: Alexander
- family-names: Patil
given-names: Indrajeet
email: patilindrajeet.science@gmail.com
orcid: https://orcid.org/0000-0003-1995-6531
year: '2023'
- type: software
title: processx
abstract: 'processx: Execute and Control System Processes'
notes: Suggests
url: https://processx.r-lib.org
repository: https://CRAN.R-project.org/package=processx
authors:
- family-names: Csárdi
given-names: Gábor
email: csardi.gabor@gmail.com
orcid: https://orcid.org/0000-0001-7098-9676
- family-names: Chang
given-names: Winston
year: '2023'
- type: software
title: paws
abstract: 'paws: Amazon Web Services Software Development Kit'
notes: Suggests
url: https://github.com/paws-r/paws
repository: https://CRAN.R-project.org/package=paws
authors:
- family-names: Kretch
given-names: David
email: david.kretch@gmail.com
- family-names: Banker
given-names: Adam
email: adam.banker39@gmail.com
year: '2023'
- type: software
title: httr
abstract: 'httr: Tools for Working with URLs and HTTP'
notes: Suggests
url: https://httr.r-lib.org/
repository: https://CRAN.R-project.org/package=httr
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2023'
- type: software
title: autotest
abstract: 'autotest: Automatic Package Testing'
notes: Suggests
url: https://docs.ropensci.org/autotest/
repository: https://ropensci-review-tools.r-universe.dev
authors:
- family-names: Padgham
given-names: Mark
email: mark.padgham@email.com
orcid: https://orcid.org/0000-0003-2172-5265
year: '2023'
- type: software
title: callr
abstract: 'callr: Call R from R'
notes: Suggests
url: https://callr.r-lib.org
repository: https://CRAN.R-project.org/package=callr
authors:
- family-names: Csárdi
given-names: Gábor
email: csardi.gabor@gmail.com
orcid: https://orcid.org/0000-0001-7098-9676
- family-names: Chang
given-names: Winston
year: '2023'
- type: software
title: spelling
abstract: 'spelling: Tools for Spell Checking in R'
notes: Suggests
url: https://docs.ropensci.org/spelling/
repository: https://CRAN.R-project.org/package=spelling
authors:
- family-names: Ooms
given-names: Jeroen
email: jeroen@berkeley.edu
orcid: https://orcid.org/0000-0002-4035-0289
- family-names: Hester
given-names: Jim
email: james.hester@rstudio.com
year: '2023'
identifiers:
- type: url
value: https://ecohealthalliance.r-universe.dev/relic
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "relic",
"description": "Tools working with the history of version-controlled projects, ",
"name": "relic: Objects from History",
"relatedLink": "https://ecohealthalliance.r-universe.dev/relic",
"codeRepository": "https://ecohealthalliance.github.io/relic",
"issueTracker": "https://github.com/ecohealthalliance/relic/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.1.0.9000",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.3.1 (2023-06-16)",
"author": [
{
"@type": "Person",
"givenName": "Noam",
"familyName": "Ross",
"email": "ross@ecohealthalliance.org",
"@id": "https://orcid.org/0000-0002-2136-0000"
}
],
"copyrightHolder": [
{
"@type": "Organization",
"name": "EcoHealth Alliance"
}
],
"funder": [
{
"@type": "Organization",
"name": "EcoHealth Alliance"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "Noam",
"familyName": "Ross",
"email": "ross@ecohealthalliance.org",
"@id": "https://orcid.org/0000-0002-2136-0000"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "igraph",
"name": "igraph",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=igraph"
},
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "targets",
"name": "targets",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=targets"
},
{
"@type": "SoftwareApplication",
"identifier": "testthat",
"name": "testthat",
"version": ">= 3.0.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=testthat"
},
{
"@type": "SoftwareApplication",
"identifier": "devtag",
"name": "devtag",
"sameAs": "https://github.com/moodymudskipper/devtag"
},
{
"@type": "SoftwareApplication",
"identifier": "pkgcheck",
"name": "pkgcheck",
"sameAs": "https://github.com/ropensci-review-tools/pkgcheck"
},
{
"@type": "SoftwareApplication",
"identifier": "lintr",
"name": "lintr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=lintr"
},
{
"@type": "SoftwareApplication",
"identifier": "processx",
"name": "processx",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=processx"
},
{
"@type": "SoftwareApplication",
"identifier": "paws",
"name": "paws",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=paws"
},
{
"@type": "SoftwareApplication",
"identifier": "httr",
"name": "httr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=httr"
},
{
"@type": "SoftwareApplication",
"identifier": "autotest",
"name": "autotest"
},
{
"@type": "SoftwareApplication",
"identifier": "callr",
"name": "callr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=callr"
},
{
"@type": "SoftwareApplication",
"identifier": "spelling",
"name": "spelling",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=spelling"
}
],
"softwareRequirements": {
"1": {
"@type": "SoftwareApplication",
"identifier": "git2r",
"name": "git2r",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://github.com/ropensci/git2r"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "fs",
"name": "fs",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=fs"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "rlang",
"name": "rlang",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rlang"
},
"SystemRequirements": null
},
"fileSize": "643.785KB",
"citation": [
{
"@type": "SoftwareSourceCode",
"datePublished": "2024",
"author": [
{
"@type": "Person",
"givenName": "Noam",
"familyName": "Ross"
}
],
"name": "relic: Tools for working with version-controlled data science workflows",
"url": "https://github.com/ecohealthalliance/relic"
}
]
}
GitHub Events
Total
- Watch event: 3
- Push event: 1
- Fork event: 1
Last Year
- Watch event: 3
- Push event: 1
- Fork event: 1
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Noam Ross | r****s@e****g | 73 |
| Noam Ross | n****s@g****m | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 14
- Total pull requests: 4
- Average time to close issues: N/A
- Average time to close pull requests: 37 minutes
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.75
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- noamross (13)
Pull Request Authors
- noamross (4)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
.github/workflows/R-CMD-check.yaml
actions
- actions/checkout v3 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgcheck.yaml
actions
- ropensci-review-tools/pkgcheck-action main composite
.github/workflows/pkgdown.yaml
actions
- JamesIves/github-pages-deploy-action v4.4.1 composite
- actions/checkout v3 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml
actions
- actions/checkout v3 composite
- r-lib/actions/pr-fetch v2 composite
- r-lib/actions/pr-push v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml
actions
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION
cran
- fs * imports
- git2r * imports
- devtag * suggests
- igraph * suggests
- knitr * suggests
- lintr * suggests
- pkgcheck * suggests
- rmarkdown * suggests
- targets * suggests
- testthat >= 3.0.0 suggests
.github/workflows/update-docs-and-meta.yaml
actions
- actions/checkout v3 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite