metadata2: Metadata

In steinbaugh/brio: Pipette Biological Data In and Out of R

Metadata

Description

Dynamically handles metadata assignment and extraction in a similar fashion for both S3 and S4 objects.

Usage

metadata2(x, which, ...)

metadata2(x, which, ...) <- value

## S4 method for signature 'ANY,character'
metadata2(x, which)

## S4 method for signature 'Annotated,character'
metadata2(x, which)

## S4 replacement method for signature 'ANY,character'
metadata2(x, which) <- value

## S4 replacement method for signature 'Annotated,character'
metadata2(x, which) <- value

Arguments

x	Object.
which	character(1). A non-empty character string specifying which attribute is to be accessed. Note that positional numeric arguments are currently not allowed.
value	ANY. Metadata values to assign into slot, defined by which.
...	Additional arguments.

Value

• metadata2(): Metadata. Returns NULL on which match failure, similar to attr() and metadata().

• ⁠metadata2<-()⁠: Modified object.

S3 class

Internally slots into attributes(). Attribute is also accessible via attr(object, which).

S4 class

Requires that object extends Annotated class. Internally slots into metadata(). Attribute is also accessible via metadata(object)[[which]].

Note

Updated 2021-10-14.

Examples

## S3 ====
x <- data.frame()
metadata2(x, which = "A") <- "B"
metadata2(x, which = "A")
attr(x, which = "A")

## S4 (extending Annotated) ====
x <- S4Vectors::DataFrame()
metadata2(x, which = "A") <- "B"
metadata2(x, which = "A")

steinbaugh/brio documentation built on Feb. 1, 2024, 6:42 p.m.