-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Noam Ross
committed
Nov 9, 2023
1 parent
94d138a
commit 1b1d132
Showing
2 changed files
with
67 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,65 @@ | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
|
||
| # gitty | ||
| # relic: objects from history | ||
|
|
||
| <!-- badges: start --> | ||
|
|
||
| [](https://www.repostatus.org/#concept) | ||
| [](https://github.com/noamross/gitty/actions/workflows/R-CMD-check.yaml) | ||
| [](https://codecov.io/gh/noamross/gitty) | ||
| [](https://github.com/noamross/gitty/actions?query=workflow%3Apkgcheck) | ||
| [](https://noamross.r-universe.dev/gitty) | ||
| [](https://github.com/noamross/relic/actions/workflows/R-CMD-check.yaml) | ||
| [](https://github.com/noamross/relic/actions?query=workflow%3Apkgcheck) | ||
| [](https://codecov.io/gh/noamross/relic) | ||
| [](https://noamross.r-universe.dev/relic) | ||
| [](https://CRAN.R-project.org/package=gitty) | ||
|
|
||
| status](https://www.r-pkg.org/badges/version/relic)](https://CRAN.R-project.org/package=relic) | ||
| <!-- badges: end --> | ||
|
|
||
| The goal of gitty is to … | ||
| The `relic` package provides tools for working with version-controlled | ||
| workflows, primarily git repositories and | ||
| [`targets`](https://books.ropensci.org/targets-manual) project. It | ||
| enables extracting and comparing files and objects from project history. | ||
|
|
||
| ## Installation | ||
|
|
||
| You can install the development version of gitty like so: | ||
|
|
||
| ``` r | ||
| install.packages("gitty", repos = c("https://noamross.r-universe.dev")) | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| This is a basic example which shows you how to solve a common problem: | ||
| You can install the development version of `relic` like so: | ||
|
|
||
| ``` r | ||
| #library(gitty) | ||
| ## basic example code | ||
| install.packages("relic", repos = c("https://noamross.r-universe.dev")) | ||
| ``` | ||
|
|
||
| What is special about using `README.Rmd` instead of just `README.md`? | ||
| You can include R chunks like so: | ||
|
|
||
| ``` r | ||
| summary(cars) | ||
| #> speed dist | ||
| #> Min. : 4.0 Min. : 2.00 | ||
| #> 1st Qu.:12.0 1st Qu.: 26.00 | ||
| #> Median :15.0 Median : 36.00 | ||
| #> Mean :15.4 Mean : 42.98 | ||
| #> 3rd Qu.:19.0 3rd Qu.: 56.00 | ||
| #> Max. :25.0 Max. :120.00 | ||
| ``` | ||
|
|
||
| You’ll still need to render `README.Rmd` regularly, to keep `README.md` | ||
| up-to-date. `devtools::build_readme()` is handy for this. | ||
|
|
||
| You can also embed plots, for example: | ||
|
|
||
| <img src="man/figures/README-pressure-1.png" width="100%" /> | ||
|
|
||
| In that case, don’t forget to commit and push the resulting figure | ||
| files, so they display on GitHub and CRAN. | ||
| ## 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 using git. | ||
| - [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 gitty project is released with a [Contributor Code | ||
| 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. | ||
| \[Copied to clipboard\] | ||
|
|
||
| `relic` is developed at [EcoHealth | ||
| Alliance](https://www.ecohealthalliance.org/). | ||
|
|
||
| [](https://www.ecohealthalliance.org/) |