customizing-metadata: customizing-metadata

In gmbecker/recordr: Semantic Annotation and Discoverability System for R-Based Artifacts

Description

The generateTags is called when extracting metadata from an object. It is one mechanism by which custom metadata can be defined on a class-by-class basis without the more heavy-weight solution of defining an entirely new FeatureSet subclass.

Usage

generateTags(object)

Arguments

object

The object to generate tags for

Details

The upsides of this mechanism is that it is easier to use and lighter weight than defining new FeatureSet classes and methods to generate them. The downsides are that the metadata are tags, rather than proper key-value pairs, as far as trackr is concerned. (A backend could be engineered such that it interpreted tags of the form 'key:value' as key-value pairs, but this won't occur without extra work, and thus those implied fields will not be queriable via the trackr api specifically. The values will be included in the metadata generally though, so non-field-specific queries will work.

Value

A character vector of tags to associate with object during the recording process

Examples

generateTags(mtcars) #character(0)

gmbecker/recordr documentation built on May 24, 2021, 10:59 a.m.