io_yamlet.data.frame: Export Data Frame Attributes as Yamlet

In bergsmat/yamlet: Versatile Curation of Table Metadata

Export Data Frame Attributes as Yamlet

Description

Writes data.frame attributes as yamlet. The data.frame method for io_yamlet. Similar to write_yamlet, but returns (description of) con.

Usage

## S3 method for class 'data.frame'
io_yamlet(
  x,
  con = stdout(),
  eol = "\n",
  useBytes = FALSE,
  default_keys = getOption("yamlet_default_keys", list("label", "guide")),
  fileEncoding = getOption("encoding"),
  ...
)

Arguments

x	data.frame
con	passed to writeLines
eol	end-of-line; passed to writeLines as sep
useBytes	passed to writeLines
default_keys	character: default keys for the first n anonymous members of each element
fileEncoding	if con is character, passed to file as encoding
...	passed to as_yamlet

Value

invisible description of con: i.e., a file path

See Also

Other interface: canonical.decorated(), classified.data.frame(), decorate.character(), decorate.data.frame(), desolve.decorated(), ggplot.decorated(), io_csv.character(), io_csv.data.frame(), io_res.character(), io_res.decorated(), io_table.character(), io_table.data.frame(), io_yamlet.character(), is_parseable.default(), mimic.default(), modify.default(), promote.list(), read_yamlet(), resolve.decorated(), scripted.default(), selected.default(), write_yamlet()

Other io: io_csv.character(), io_csv.data.frame(), io_csv(), io_res.character(), io_res.decorated(), io_res(), io_table.character(), io_table.data.frame(), io_table(), io_yamlet.character(), io_yamlet.yamlet(), io_yamlet()

Examples

library(csv)
file <- system.file(package = 'yamlet', 'extdata','quinidine.csv')
x <- decorate(file)
out <- file.path(tempdir(), 'out.yamlet')
io_yamlet(x, out)
io_yamlet(out)

bergsmat/yamlet documentation built on Feb. 18, 2024, 5:50 a.m.