Skip to content

Commit

Permalink
Update description
Browse files Browse the repository at this point in the history
  • Loading branch information
ThierryO committed Jan 14, 2021
1 parent 8ee9032 commit 653b996
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 8 deletions.
31 changes: 27 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,34 @@ Authors@R:
person(given = "Research Institute for Nature and Forest",
role = c("cph", "fnd"),
email = "[email protected]"))
Description: Make versioning of data.frame easy and efficient using git
repositories.
Description: The git2rdata package is an R package for writing and reading
dataframes as plain text files.
A metadata file stores important information.
1) Storing metadata allows to maintain the classes of variables.
By default, git2rdata optimizes the data for file storage.
The optimization is most effective on data containing factors.
The optimization makes the data less human readable.
The user can turn this off when they prefer a human readable format over
smaller files.
Details on the implementation are available in
vignette("plain_text", package = "git2rdata").
2) Storing metadata also allows smaller row based diffs between two
consecutive commits.
This is a useful feature when storing data as plain text files under version
control.
Details on this part of the implementation are available in
vignette("version_control", package = "git2rdata").
Although we envisioned git2rdata with a git workflow in mind, you can use it
in combination with other version control systems like subversion or
mercurial.
3) git2rdata is a useful tool in a reproducible and traceable workflow.
vignette("workflow", package = "git2rdata") gives a toy example.
4) vignette("efficiency", package = "git2rdata") provides some insight into
the efficiency of file storage, git repository size and speed for writing and
reading.
Please cite using <doi:10.5281/zenodo.1485309>.
License: GPL-3
URL: https://github.com/ropensci/git2rdata,
https://doi.org/10.5281/zenodo.1485309
URL: https://ropensci.github.io/git2rdata/
BugReports: https://github.com/ropensci/git2rdata/issues
Depends:
R (>= 3.5.0)
Expand Down
31 changes: 27 additions & 4 deletions man/git2rdata-package.Rd

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

0 comments on commit 653b996

Please sign in to comment.