getMetadata: Retrieve the metadata object for a run

Description Usage Arguments Value

Description

When a script or console session is recorded (see record() and startrecord()), a metadata object is created that describes the objects associated with the run, using the Ecological Metadata Language https://knb.ecoinformatics.org/#external//emlparser/docs/index.html. This metadata can be retrieved from the recordr cache for review or editing if desired. If the metadata is updated, it can be re-inserted into the recordr cache using the putMetadata method.

Usage

1
2
3
4
5
getMetadata(recordr, ...)

## S4 method for signature 'Recordr'
getMetadata(recordr, id = as.character(NA),
  seq = as.character(NA), as = as.character("text"))

Arguments

recordr

a Recordr instance

...

additional parameters seealso Recordr class description

id

The identifier for a run

seq

The sequence number for a run

as

Form to return the metadata as. Possible values are: "text", "parsed" (for parsed XML), or "EML" (for an EML R package S4 object)

Value

A character vector containing the metadata


NCEAS/recordr documentation built on May 7, 2019, 5:59 p.m.