Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create and upload high res logo #37

Merged
merged 9 commits into from
Jun 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions .zenodo.json

This file was deleted.

10 changes: 7 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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"),
Expand All @@ -10,6 +10,10 @@ Authors@R: c(
"Floris", "Vanderhaeghe", role = "ctb",
email = "[email protected]",
comment = c(ORCID = "0000-0002-6378-6229")),
person(
"Peter", "Desmet", role = "ctb",
email = "[email protected]",
comment = c(ORCID = "0000-0002-8442-8025")),
person(
"Research Institute for Nature and Forest",
role = c("cph", "fnd"), email = "[email protected]"))
Expand All @@ -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'
Expand Down
7 changes: 7 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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)
============================

Expand Down
2 changes: 1 addition & 1 deletion R/prune.R
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<p style="display:none">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.</p>
<p style="display:none">**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.**</p>

## Rationale

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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
Expand All @@ -120,7 +123,6 @@ git2rdata
├── man-roxygen
├── pkgdown
├── R
├── sticker
├─┬ tests
│ └── testthat
└── vignettes
Expand Down
4 changes: 2 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -43,4 +43,4 @@ authors:
href: "https://www.muscardinus.be"
Research Institute for Nature and Forest:
href: "https://www.inbo.be/en"
html: "<img src='https://inbo.github.io/git2rdata/reference/figures/logo_en.png' height=24>"
html: "<img src='https://ropensci.github.io/git2rdata/reference/figures/logo_en.png' height=24>"
19 changes: 13 additions & 6 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -35,6 +35,13 @@
"familyName": "Vanderhaeghe",
"email": "[email protected]",
"@id": "https://orcid.org/0000-0002-6378-6229"
},
{
"@type": "Person",
"givenName": "Peter",
"familyName": "Desmet",
"email": "[email protected]",
"@id": "https://orcid.org/0000-0002-8442-8025"
}
],
"copyrightHolder": [
Expand Down Expand Up @@ -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",
Expand Down
Binary file modified man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions man/git2rdata-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/rm_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon.ico
Binary file not shown.
Binary file removed sticker/git.png
Binary file not shown.
114 changes: 0 additions & 114 deletions sticker/sticker.R

This file was deleted.