putMetadata: Update the metadata object for a run

Description Usage Arguments Details Value See Also

Description

Put a metadata document into the recordr cache for an run, replacing the existing metadata object for the specified run, if one exists.

Usage

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

## S4 method for signature 'Recordr'
putMetadata(recordr, id = as.character(NA),
  seq = as.character(NA), metadata = as.character(NA), asText = TRUE)

Arguments

recordr

a Recordr instance

...

additional parameters

id

The identifier for a run

seq

The sequence number for a run

metadata

The replacement metadata, as the actual text, or as a filename containing the metadata

asText

A logical. See 'Details'. If TRUE, then the metadata parameter is a character vector containing metadata, ir FALSE it is a filename. The default is TRUE.

Details

The metadata parameter can specify either a character vector that contains the metadata this parameter can be a filename that contains the metadata. The asText parameter is used to specify which type of value is specified. If asText is TRUE, then the metadata parameter is a character vector, if it is FALSE, then the metadata parameter is a filename.

Value

A character vector containing the metadata

See Also

Recordr class description


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