Learn R Programming

teal.reporter (version 0.6.0)

metadata: Access metadata from a teal_card or ReportCard

Description

This function retrieves metadata from a teal_card or ReportCard object. When which is NULL, it returns all metadata fields as a list.

Usage

metadata(object, which = NULL)

# S3 method for teal_card metadata(object, which = NULL)

# S3 method for ReportCard metadata(object, which = NULL)

Value

A list of metadata fields or a specific field if which is provided.

Arguments

object

(teal_card or ReportCard) The object from which to extract metadata.

which

(character or NULL) The name of the metadata field to extract.