diff --git a/.zenodo.json b/.zenodo.json deleted file mode 100644 index e9f93d2..0000000 --- a/.zenodo.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "creators": [ - { - "affiliation": "Research Institute for Nature and Forest (INBO)", - "name": "Onkelinx, Thierry", - "orcid": "0000-0001-8804-4216" - } - ], - "contributors": [ - { - "affiliation": "Research Institute for Nature and Forest (INBO)", - "name": "Onkelinx, Thiery", - "orcid": "0000-0001-8804-4216", - "type": ["Contactperson", "ProjectLeader"] - }, - { - "affiliation": "Research Institute for Nature and Forest (INBO)", - "name": "Vanderhaeghe, Floris", - "orcid": "0000-0002-6378-6229", - "type": "Projectmember" - }, - { - "name": "Research Institute for Nature and Forest (INBO)", - "type": "Rightsholder" - } - ], - "keywords": [ - "r", - "version control", - "data.frame", - "plain text" - ], - "license": "GPL-3" -} diff --git a/DESCRIPTION b/DESCRIPTION index f5f818e..84cd963 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: git2rdata Title: Store and Retrieve Data.frames in a Git Repository -Version: 0.0.5 +Version: 0.1 Authors@R: c( person( "Thierry", "Onkelinx", role = c("aut", "cre"), @@ -10,6 +10,10 @@ Authors@R: c( "Floris", "Vanderhaeghe", role = "ctb", email = "floris.vanderhaeghe@inbo.be", comment = c(ORCID = "0000-0002-6378-6229")), + person( + "Peter", "Desmet", role = "ctb", + email = "peter.desmet@inbo.be", + comment = c(ORCID = "0000-0002-8442-8025")), person( "Research Institute for Nature and Forest", role = c("cph", "fnd"), email = "info@inbo.be")) @@ -31,8 +35,8 @@ Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) RoxygenNote: 6.1.1 -URL: https://github.com/inbo/git2rdata, https://doi.org/10.5281/zenodo.1485309 -BugReports: https://github.com/inbo/git2rdata/issues +URL: https://github.com/ropensci/git2rdata, https://doi.org/10.5281/zenodo.1485309 +BugReports: https://github.com/ropensci/git2rdata/issues Collate: 'clean_data_path.R' 'git2rdata-package.R' diff --git a/NEWS.md b/NEWS.md index 8736d97..6b9563b 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,10 @@ +git2rdata 0.1 (2019-06-04) +============================ + + * Transfer to rOpenSci. + * Use new logo (@peterdesmet, #37). + * Add estimate of upper bound of the number of commits. + git2rdata 0.0.5 (2019-05-21) ============================ diff --git a/R/prune.R b/R/prune.R index 4b22c6d..d717042 100644 --- a/R/prune.R +++ b/R/prune.R @@ -58,7 +58,7 @@ rm_data.character <- function( #' listed in a `.gitignore` file. Selecting `modified` will remove both #' `unmodified` and `modified` data files. Selecting `ìgnored` will remove #' `unmodified`, `modified` and `ignored` data files. `all` refers to all -#' visible data files, inclusing `untracked` files. +#' visible data files, including `untracked` files. #' @rdname rm_data rm_data.git_repository <- function( root, path = NULL, recursive = TRUE, ..., stage = FALSE, diff --git a/README.md b/README.md index d271921..a3c4e06 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,16 @@ [![minimal R version](https://img.shields.io/badge/R%3E%3D-3.5.0-6666ff.svg)](https://cran.r-project.org/) [![DOI](https://zenodo.org/badge/147685405.svg)](https://zenodo.org/badge/latestdoi/147685405) -[![Travis-CI Build Status](https://travis-ci.org/inbo/git2rdata.svg?branch=master)](https://travis-ci.org/inbo/git2rdata) -[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/a3idhi9f6ls9xu8r/branch/master?svg=true)](https://ci.appveyor.com/project/ThierryO/git2rdata/branch/master) -[![codecov](https://codecov.io/gh/inbo/git2rdata/branch/master/graph/badge.svg)](https://codecov.io/gh/inbo/git2rdata) +[![Travis-CI Build Status](https://travis-ci.org/ropensci/git2rdata.svg?branch=master)](https://travis-ci.org/ropensci/git2rdata) +[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/cfbjb835fqb3dc7m/branch/master?svg=true)](https://ci.appveyor.com/project/ThierryO/git2rdata-n60yg/branch/master) +[![codecov](https://codecov.io/gh/ropensci/git2rdata/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/git2rdata) -![GitHub forks](https://img.shields.io/github/forks/inbo/git2rdata.svg?style=social) -![GitHub stars](https://img.shields.io/github/stars/inbo/git2rdata.svg?style=social) -![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/inbo/git2rdata.svg) -![GitHub repo size](https://img.shields.io/github/repo-size/inbo/git2rdata.svg) +![GitHub forks](https://img.shields.io/github/forks/ropensci/git2rdata.svg?style=social) +![GitHub stars](https://img.shields.io/github/stars/ropensci/git2rdata.svg?style=social) +![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ropensci/git2rdata.svg) +![GitHub repo size](https://img.shields.io/github/repo-size/ropensci/git2rdata.svg) -

Please visit the git2rdata website at https://inbo.github.io/git2rdata/. The vignette code on the website link to a rendered version of the vignette. Functions have a link to their help file.

+

**Please visit the git2rdata website at https://ropensci.github.io/git2rdata/. The vignette code on the website link to a rendered version of the vignette. Functions have a link to their help file.**

## Rationale @@ -54,13 +54,13 @@ Install the development version # install with vignettes (recommended) remotes::install_github( - "inbo/git2rdata", + "ropensci/git2rdata", build = TRUE, dependencies = TRUE, build_opts = c("--no-resave-data", "--no-manual") ) # install without vignettes -remotes::install_github("inbo/git2rdata")) +remotes::install_github("ropensci/git2rdata")) ``` ## Usage in a Nutshell @@ -93,7 +93,11 @@ Please read `vignette("version_control", package = "git2rdata")` for more detail ## What data sizes can `git2rdata` handle? -The recommendation for git repositories is to use files smaller than 100 MB, an overall repository size less than 1 GB and less than 25k files. The individual file size is the limiting factor. Storing the airbag dataset ([`DAAG::nassCDS`](https://cran.r-project.org/package=DAAG)) with `write_vc()` requires on average 68 (optimized) or 97 (verbose) byte per record. The 100 MB file limit for this data is reached after about 1.5 million (optimize) or 1 million (verbose) observations. Your mileage might vary. +The recommendation for git repositories is to use files smaller than 100 MiB, an overall repository size less than 1 GiB and less than 25k files. The individual file size is the limiting factor. Storing the airbag dataset ([`DAAG::nassCDS`](https://cran.r-project.org/package=DAAG)) with `write_vc()` requires on average 68 (optimized) or 97 (verbose) byte per record. The 100 MiB file limit for this data is reached after about 1.5 million (optimize) or 1 million (verbose) observations. + +Storing a 90% random subset of the airbag dataset requires 370 kiB (optimized) or 400 kiB (verbose) storage in the git history. Updating the dataset with other 90% random subsets requires on average 60 kiB (optimized) to 100 kiB (verbose) per commit. The git history limit of 1 GiB will be reached after 17k (optimized) to 10k (verbose) commits. + +Your mileage might vary. ## Citation @@ -107,9 +111,8 @@ Please use the output of `citation("git2rdata")` - `testthat`: R scripts with unit tests using the [testthat](http://testthat.r-lib.org/) framework - `vignettes`: source code for the vignettes describing the package - `man-roxygen`: templates for documentation in Roxygen format -- `pkgdown`: additional source files for the `git2rdata` [website](https://inbo.github.io/git2rdata/) +- `pkgdown`: additional source files for the `git2rdata` [website](https://ropensci.github.io/git2rdata/) - `.github`: guidelines and templates for contributors -- `sticker`: source code for the `git2rdata` hex sticker ``` git2rdata @@ -120,7 +123,6 @@ git2rdata ├── man-roxygen ├── pkgdown ├── R -├── sticker ├─┬ tests │ └── testthat └── vignettes diff --git a/_pkgdown.yml b/_pkgdown.yml index 0020739..4629d14 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -21,7 +21,7 @@ navbar: href: CONTRIBUTING.html right: - icon: fa-github fa-lg - href: https://github.com/inbo/git2rdata + href: https://github.com/ropensci/git2rdata - icon: fa-twitter fa-lg href: https://twitter.com/INBOVlaanderen - icon: fa-facebook fg-lg @@ -43,4 +43,4 @@ authors: href: "https://www.muscardinus.be" Research Institute for Nature and Forest: href: "https://www.inbo.be/en" - html: "" + html: "" diff --git a/codemeta.json b/codemeta.json index e45203f..87c4a01 100644 --- a/codemeta.json +++ b/codemeta.json @@ -7,11 +7,11 @@ "identifier": "git2rdata", "description": "Make versioning of data.frame easy and efficient using git repositories.", "name": "git2rdata: Store and Retrieve Data.frames in a Git Repository", - "codeRepository": "https://github.com/inbo/git2rdata", + "codeRepository": "https://github.com/ropensci/git2rdata", "relatedLink": "https://doi.org/10.5281/zenodo.1485309", - "issueTracker": "https://github.com/inbo/git2rdata/issues", + "issueTracker": "https://github.com/ropensci/git2rdata/issues", "license": "https://spdx.org/licenses/GPL-3.0", - "version": "0.0.5", + "version": "0.1", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", @@ -35,6 +35,13 @@ "familyName": "Vanderhaeghe", "email": "floris.vanderhaeghe@inbo.be", "@id": "https://orcid.org/0000-0002-6378-6229" + }, + { + "@type": "Person", + "givenName": "Peter", + "familyName": "Desmet", + "email": "peter.desmet@inbo.be", + "@id": "https://orcid.org/0000-0002-8442-8025" } ], "copyrightHolder": [ @@ -172,9 +179,9 @@ "sameAs": "https://CRAN.R-project.org/package=yaml" } ], - "releaseNotes": "https://github.com/inbo/git2rdata/blob/master/NEWS.md", - "readme": "https://github.com/inbo/git2rdata/blob/master/README.md", - "fileSize": "348.673KB", + "releaseNotes": "https://github.com/ropensci/git2rdata/blob/master/NEWS.md", + "readme": "https://github.com/ropensci/git2rdata/blob/master/README.md", + "fileSize": "363.46KB", "contIntegration": [ "https://travis-ci.org/inbo/git2rdata", "https://ci.appveyor.com/project/ThierryO/git2rdata/branch/master", diff --git a/man/figures/logo.png b/man/figures/logo.png index 9f56815..92550c2 100644 Binary files a/man/figures/logo.png and b/man/figures/logo.png differ diff --git a/man/git2rdata-package.Rd b/man/git2rdata-package.Rd index d2c4fe8..d17b9fd 100644 --- a/man/git2rdata-package.Rd +++ b/man/git2rdata-package.Rd @@ -13,9 +13,9 @@ Make versioning of data.frame easy and efficient using git repositories. \seealso{ Useful links: \itemize{ - \item \url{https://github.com/inbo/git2rdata} + \item \url{https://github.com/ropensci/git2rdata} \item \url{https://doi.org/10.5281/zenodo.1485309} - \item Report bugs at \url{https://github.com/inbo/git2rdata/issues} + \item Report bugs at \url{https://github.com/ropensci/git2rdata/issues} } } @@ -25,6 +25,7 @@ Useful links: Other contributors: \itemize{ \item Floris Vanderhaeghe \email{floris.vanderhaeghe@inbo.be} (0000-0002-6378-6229) [contributor] + \item Peter Desmet \email{peter.desmet@inbo.be} (0000-0002-8442-8025) [contributor] \item Research Institute for Nature and Forest \email{info@inbo.be} [copyright holder, funder] } diff --git a/man/rm_data.Rd b/man/rm_data.Rd index 8f64aef..db49c08 100644 --- a/man/rm_data.Rd +++ b/man/rm_data.Rd @@ -30,7 +30,7 @@ the git history and changed since the last commit. \code{ignored} refers to file listed in a \code{.gitignore} file. Selecting \code{modified} will remove both \code{unmodified} and \code{modified} data files. Selecting \code{ìgnored} will remove \code{unmodified}, \code{modified} and \code{ignored} data files. \code{all} refers to all -visible data files, inclusing \code{untracked} files.} +visible data files, including \code{untracked} files.} } \value{ returns invisibily a vector of removed files names. The paths are diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png index 3c07f97..b0c6ee1 100644 Binary files a/pkgdown/favicon/apple-touch-icon-120x120.png and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png index d97e476..23a3f0c 100644 Binary files a/pkgdown/favicon/apple-touch-icon-152x152.png and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png index ae96ac5..bc7c5b7 100644 Binary files a/pkgdown/favicon/apple-touch-icon-180x180.png and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png index 44cf1a0..c166029 100644 Binary files a/pkgdown/favicon/apple-touch-icon-60x60.png and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png index 3dac8b6..680a148 100644 Binary files a/pkgdown/favicon/apple-touch-icon-76x76.png and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png index ae96ac5..bc7c5b7 100644 Binary files a/pkgdown/favicon/apple-touch-icon.png and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png index 3cb6c4c..3031fcd 100644 Binary files a/pkgdown/favicon/favicon-16x16.png and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png index 29cf7cd..eb55084 100644 Binary files a/pkgdown/favicon/favicon-32x32.png and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico index 69c4576..6c4da87 100644 Binary files a/pkgdown/favicon/favicon.ico and b/pkgdown/favicon/favicon.ico differ diff --git a/sticker/git.png b/sticker/git.png deleted file mode 100644 index cad3823..0000000 Binary files a/sticker/git.png and /dev/null differ diff --git a/sticker/sticker.R b/sticker/sticker.R deleted file mode 100644 index 609d839..0000000 --- a/sticker/sticker.R +++ /dev/null @@ -1,114 +0,0 @@ -library(tidyverse) -library(magick) -library(cowplot) -transparent <- TRUE -image_read("../man/figures/logo_en.png") %>% - image_rotate(30) %>% - image_transparent(color = ifelse(transparent, "white", "black")) %>% - image_write("inbo.png") -scale <- 1 -dx <- 1 -dy <- sqrt(2) -corner <- 1/3 -git_colour <- "#c04384" -icon <- tribble( - ~x, ~y, - 0, 0, - dx, 0, - dx, dy - corner * dx, - dx - corner * dx, dy - corner * dx, - dx - corner * dx, dy, - dx, dy - corner * dx, - dx - corner * dx, dy, - 0, dy, - 0, 0, - dx, 0 -) %>% - ggplot(aes(x = x, y = y)) + - geom_path(colour = git_colour, size = 1, linejoin = "round") + - coord_fixed() + - annotate( - "text", label = "TXT", colour = git_colour, - x = dx / 2, y = dy / 3, hjust = 0.5, vjust = 0.5, - size = 5 * scale, family = "Flanders Art Sans" - ) + - theme_void() -meta <- tribble( - ~x, ~y, - 0, 0, - dx, 0, - dx, dy - corner * dx, - dx - corner * dx, dy - corner * dx, - dx - corner * dx, dy, - dx, dy - corner * dx, - dx - corner * dx, dy, - 0, dy, - 0, 0, - dx, 0 -) %>% - ggplot(aes(x = x, y = y)) + - geom_path(colour = git_colour, size = 1, linejoin = "round") + - coord_fixed() + - annotate( - "text", label = "meta", colour = git_colour, - x = dx / 2, y = dy / 3, hjust = 0.5, vjust = 0.5, - size = 5 * scale, family = "Flanders Art Sans" - ) + - theme_void() -hexagon <- tibble( - angle = seq(0, 2, length = 7) * pi + pi / 2, - range = 1 -) %>% - mutate( - x = range * cos(angle), - y = range * sin(angle) - ) %>% - ggplot(aes(x = x, y = y)) + - geom_polygon(fill = NA, colour = git_colour, size = 3 * scale) + - coord_fixed() + - theme_void() - -df <- crossing( - x = 1:5, - y = 0:-8 -) %>% - mutate( - x2 = x + 1, - y2 = y - 1, - fill = ifelse(y == 0, "row", NA) - ) %>% - ggplot(aes(xmin = x, ymin = y, xmax = x2, ymax = y2, fill = fill)) + - geom_rect(colour = git_colour) + - scale_discrete_manual( - values = git_colour, na.value = NA, guide = "none", aesthetics = "fill" - ) + - coord_fixed(1/2) + - theme_void() -sticker <- ggdraw() + - draw_image("inbo.png", x = -0.2, y = -0.28, scale = 0.45) + - draw_plot(hexagon) + - draw_label( - "git2rdata", x = 0.5, y = 0.8, - colour = git_colour, fontfamily = "Flanders Art Sans", size = 20 * scale - ) + - draw_plot(df, x = -0.27, scale = 0.3) + - draw_label( - "\u21C4", colour = git_colour, fontfamily = "Flanders Art Sans", - size = 40 * scale - ) + - draw_image("git.png", x = 0.25, y = -0.18, scale = 0.25) + - draw_label( - "+", colour = git_colour, fontfamily = "Flanders Art Sans", - size = 40 * scale, x = 0.75 - ) + - draw_plot(meta, x = 0.35, y = 0.15, scale = 0.2) + - draw_plot(icon, x = 0.15, y = 0.15, scale = 0.2) -save_plot( - filename = "../man/figures/logo.png", - sticker, - base_height = scale * 278 / 72, - base_width = scale * 240 / 72, - dpi = 72, - bg = ifelse(transparent, NA, "white") -) -file.remove("inbo.png")