as_yamlet.yam: Coerce Yam To Yamlet Format

In yamlet: Versatile Curation of Table Metadata

Coerce Yam To Yamlet Format

Description

Coerces yam to yamlet format. If the object or user specifies default keys, these are applied See as_yamlet.character.

Usage

## S3 method for class 'yam'
as_yamlet(
  x,
  default_keys = getOption("yamlet_default_keys", list("label", "guide")),
  ...
)

Arguments

x	a yam object; see as_yam
default_keys	character: default keys for the first n anonymous members of each element
...	ignored

Value

yamlet: a named list with default keys applied

See Also

Other yamlet: [.yamlet(), as.character.yamlet(), as_yamlet(), as_yamlet.character(), as_yamlet.data.frame(), as_yamlet.list(), as_yamlet.yamlet(), print.yamlet()

Examples

file <- system.file(package = 'yamlet', 'extdata','quinidine.yaml')
file
as_yamlet(as_yam(file))

yamlet documentation built on June 8, 2025, 1:57 p.m.