update_metadata

Allows to update the description of the fields, the table name, the title,
and the description of a <code>git2rdata</code> object.
All arguments are optional.
Setting an argument to <code>NA</code> or an empty string will remove the corresponding
field from the metadata.

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) 

update_metadata function

<dl><dt>file</dt>
<dd>the name of the git2rdata object. Git2rdata objects cannot
have dots in their name. The name may include a relative path. <code>file</code> is a
path relative to the <code>root</code>.
Note that <code>file</code> must point to a location within <code>root</code>.</dd>
<dt>root</dt>
<dd>The root of a project. Can be a file path or a <code>git-repository</code>.
Defaults to the current working directory (<code>"."</code>).</dd>
<dt>field_description</dt>
<dd>a named character vector with the new descriptions
for the fields.
The names of the vector must match the variable names.</dd>
<dt>name</dt>
<dd>a character string with the new table name of the object.</dd>
<dt>title</dt>
<dd>a character string with the new title of the object.</dd>
<dt>description</dt>
<dd>a character string with the new description of the object.</dd>
<dt>...</dt>
<dd>parameters used in some methods</dd></dl>

Arguments

Update the description of a git2rdata object — update_metadata

<dl>

<dt>file</dt>
<dd>the name of the git2rdata object. Git2rdata objects cannot
have dots in their name. The name may include a relative path. <code>file</code> is a
path relative to the <code>root</code>.
Note that <code>file</code> must point to a location within <code>root</code>.</dd>


<dt>root</dt>
<dd>The root of a project. Can be a file path or a <code>git-repository</code>.
Defaults to the current working directory (<code>"."</code>).</dd>


<dt>field_description</dt>
<dd>a named character vector with the new descriptions
for the fields.
The names of the vector must match the variable names.</dd>


<dt>name</dt>
<dd>a character string with the new table name of the object.</dd>


<dt>title</dt>
<dd>a character string with the new title of the object.</dd>


<dt>description</dt>
<dd>a character string with the new description of the object.</dd>


<dt>...</dt>
<dd>parameters used in some methods</dd>

</dl>

update_metadata: Update the description of a `git2rdata` object

Description

Usage

Arguments

See Also