display_metadata

Display metadata for a <code>git2rdata</code> object

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.

Thierry Onkelinx

git2rdata

Store and Retrieve Data.frames in a Git Repository

Floris Vanderhaeghe

Peter Desmet

Els Lommelen

Research Institute for Nature and Forest (INBO) 

display_metadata function

<dl><dt>x</dt>
<dd>a <code>git2rdata</code> object</dd>
<dt>minimal</dt>
<dd>logical, if <code>TRUE</code> only a message is displayed</dd></dl>

Arguments

Display metadata for a git2rdata object — display_metadata

<dl>

<dt>x</dt>
<dd>a <code>git2rdata</code> object</dd>


<dt>minimal</dt>
<dd>logical, if <code>TRUE</code> only a message is displayed</dd>

</dl>

display_metadata: Display metadata for a `git2rdata` object

Description

Usage

Arguments

See Also