# -------------------------------------------- # CITATION file created with {cffr} R package # See also: https://docs.ropensci.org/cffr/ # -------------------------------------------- cff-version: 1.2.0 message: 'To cite package "git2rdata" in publications use:' type: software license: GPL-3.0-only title: 'git2rdata: Store and Retrieve Data.frames in a Git Repository' version: 0.4.1 doi: 10.5281/zenodo.1485309 identifiers: - type: doi value: 10.32614/CRAN.package.git2rdata - type: url value: https://github.com/ropensci/git2rdata/ - type: url value: https://doi.org/10.5281/zenodo.1485309 abstract: 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. authors: - family-names: Onkelinx given-names: Thierry email: thierry.onkelinx@inbo.be orcid: https://orcid.org/0000-0001-8804-4216 affiliation: Research Institute for Nature and Forest (INBO) preferred-citation: type: manual title: 'git2rdata: Store and Retrieve Data.frames in a Git Repository. Version 0.4.1' authors: - family-names: Onkelinx given-names: Thierry email: thierry.onkelinx@inbo.be orcid: https://orcid.org/0000-0001-8804-4216 affiliation: Research Institute for Nature and Forest (INBO) year: '2024' url: https://ropensci.github.io/git2rdata/ abstract: 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. keywords: - git - version control - plain text data doi: 10.5281/zenodo.1485309 repository: https://thierryo.r-universe.dev repository-code: https://github.com/ropensci/git2rdata commit: 2e586572994f899868ecab50a56e15b4256c2a68 url: https://ropensci.github.io/git2rdata/ contact: - family-names: Onkelinx given-names: Thierry email: thierry.onkelinx@inbo.be orcid: https://orcid.org/0000-0001-8804-4216 affiliation: Research Institute for Nature and Forest (INBO)