update_metadata: Update the description of a 'git2rdata' object

In git2rdata: Store and Retrieve Data.frames in a Git Repository

Update the description of a git2rdata object

Description

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

Usage

update_metadata(file, root = ".", field_description, name, title, description)

Arguments

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

See Also

Other storage: display_metadata(), list_data(), prune_meta(), read_vc(), relabel(), rename_variable(), rm_data(), verify_vc(), write_vc()

git2rdata documentation built on Sept. 11, 2024, 5:51 p.m.