From 1b1d132ebe8ab756bae5c8ddf7fd25719aeabc55 Mon Sep 17 00:00:00 2001 From: Noam Ross Date: Thu, 9 Nov 2023 10:41:44 -0500 Subject: [PATCH] Update README --- README.Rmd | 60 +++++++++++++++++-------------------- README.md | 86 ++++++++++++++++++++++++++---------------------------- 2 files changed, 67 insertions(+), 79 deletions(-) diff --git a/README.Rmd b/README.Rmd index 02001a2..0f4992f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -13,55 +13,47 @@ knitr::opts_chunk$set( ) ``` -# gitty +# relic: objects from history [![Project Status: Concept](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept) -[![R-CMD-check](https://github.com/noamross/gitty/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/noamross/gitty/actions/workflows/R-CMD-check.yaml) -[![codecov](https://codecov.io/gh/noamross/gitty/branch/main/graph/badge.svg)](https://codecov.io/gh/noamross/gitty) -[![pkgcheck](https://github.com/noamross/gitty/workflows/pkgcheck/badge.svg)](https://github.com/noamross/gitty/actions?query=workflow%3Apkgcheck) -[![Gitty on R-Universe](https://noamross.r-universe.dev/badges/gitty)](https://noamross.r-universe.dev/gitty) -[![CRAN status](https://www.r-pkg.org/badges/version/gitty)](https://CRAN.R-project.org/package=gitty) - - +[![R-CMD-check](https://github.com/noamross/relic/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/noamross/relic/actions/workflows/R-CMD-check.yaml) +[![pkgcheck](https://github.com/noamross/relic/workflows/pkgcheck/badge.svg)](https://github.com/noamross/relic/actions?query=workflow%3Apkgcheck) +[![codecov](https://codecov.io/gh/noamross/relic/branch/main/graph/badge.svg)](https://codecov.io/gh/noamross/relic) +[![relic on R-Universe](https://noamross.r-universe.dev/badges/relic)](https://noamross.r-universe.dev/relic) +[![CRAN status](https://www.r-pkg.org/badges/version/relic)](https://CRAN.R-project.org/package=relic) -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: +You can install the development version of `relic` 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: - -```{r example} -#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 cars} -summary(cars) -``` +## Related work -You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this. + - [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). -You can also embed plots, for example: +## 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. -```{r pressure, echo = FALSE} -plot(pressure) -``` +`relic` is developed at [EcoHealth Alliance](https://www.ecohealthalliance.org/). -In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN. +[![Created by EcoHealth Alliance](https://raw.githubusercontent.com/ropensci/citesdb/master/vignettes/figures/eha-footer.png)](https://www.ecohealthalliance.org/) -## Code of Conduct - -Please note that the gitty 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] diff --git a/README.md b/README.md index 20a5f63..bffae30 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,65 @@ -# gitty +# relic: objects from history [![Project Status: Concept](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept) -[![R-CMD-check](https://github.com/noamross/gitty/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/noamross/gitty/actions/workflows/R-CMD-check.yaml) -[![codecov](https://codecov.io/gh/noamross/gitty/branch/main/graph/badge.svg)](https://codecov.io/gh/noamross/gitty) -[![pkgcheck](https://github.com/noamross/gitty/workflows/pkgcheck/badge.svg)](https://github.com/noamross/gitty/actions?query=workflow%3Apkgcheck) -[![Gitty on -R-Universe](https://noamross.r-universe.dev/badges/gitty)](https://noamross.r-universe.dev/gitty) +[![R-CMD-check](https://github.com/noamross/relic/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/noamross/relic/actions/workflows/R-CMD-check.yaml) +[![pkgcheck](https://github.com/noamross/relic/workflows/pkgcheck/badge.svg)](https://github.com/noamross/relic/actions?query=workflow%3Apkgcheck) +[![codecov](https://codecov.io/gh/noamross/relic/branch/main/graph/badge.svg)](https://codecov.io/gh/noamross/relic) +[![relic on +R-Universe](https://noamross.r-universe.dev/badges/relic)](https://noamross.r-universe.dev/relic) [![CRAN -status](https://www.r-pkg.org/badges/version/gitty)](https://CRAN.R-project.org/package=gitty) - +status](https://www.r-pkg.org/badges/version/relic)](https://CRAN.R-project.org/package=relic) -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: - - - -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/). + +[![Created by EcoHealth +Alliance](https://raw.githubusercontent.com/ropensci/citesdb/master/vignettes/figures/eha-footer.png)](https://www.ecohealthalliance.org/)