build_descriptor: Creates a metadata record for the data catalog

In macroecology-society/masDMT: Data Management Tools

Creates a metadata record for the data catalog

Description

Creates a metadata record for the data catalog

Usage

build_descriptor(path, data_id, bibtex = NULL, preview = NULL)

Arguments

path	Directory where to write metadata record.
data_id	Dataset unique identifier.
bibtex	Path to bibtex with dataset references. Optional.
preview	Path to preview image.

Details

The function creates a directory in the specified path named as the data_id. Within it, you will find a yaml file where you can manually edit the metadata for the new record. If a bibtex and/or a preview image are provided, the function will copy them into the new directory after testing their validity. Once filled, the yaml file can be compiled into a metadata record using compile_metadata.

Value

A Rmarkdown file that can be fed into the MAS data catalog. Optional.

macroecology-society/masDMT documentation built on July 2, 2024, 4:08 a.m.