io_csv.data.frame: Export Documented Table as CSV

In yamlet: Versatile Curation of Table Metadata

Export Documented Table as CSV

Description

Exports a data.frame as comma-separated variable, as well as a yamlet version of its decorations. A wrapper for as.csv.data.frame.

Usage

## S3 method for class 'data.frame'
io_csv(
  x,
  file = "",
  ext = getOption("yamlet_extension", ".yaml"),
  meta = stdout(),
  gz = NULL,
  useBytes = FALSE,
  default_keys = getOption("yamlet_default_keys", list("label", "guide")),
  ...
)

Arguments

x	data.frame
file	passed to as.csv.data.frame (by method dispatch)
ext	= extension for metadata equivalent of x
meta	passed as con to io_yamlet
gz	logical; guessed by default from x; if TRUE, '.gz' extension enforced present for (character) file and absent for default meta
useBytes	passed to io_yamlet
default_keys	passed to io_yamlet
...	passed to as.csv and to io_yamlet

Details

You should be able to supply exactly the connections you want for file (the data file) and meta (the metadata file) if gz is FALSE. If gz is NULL, it will be guessed from file (TRUE for character ending with '.gz' or '.GZ'). If TRUE, character file will have '.gz' extension enforced, but any '.gz' ('.GZ') will be stripped when calculating meta.

Value

invisible(file)

See Also

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

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

Examples

example(io_csv)

yamlet documentation built on Oct. 6, 2023, 9:07 a.m.