metaPrint: Print a meta.data object

View source: R/metaPrint.R

metaPrintR Documentation

Print a meta.data object

Description

Print a meta.data object

Usage

metaPrint(
  data,
  meta.data,
  file = NULL,
  file.data,
  match.data = T,
  silent = !is.null(file),
  test = F,
  debug = F
)

Arguments

data

The dataset being described (i.e. a data.frame).

meta.data

The existing meta.data object (see metaInit).

file

Path to text file to write to. If not provided, meta.data is printed to screen.

file.data

Path to the data file.

match.data

Reorder meta.data to match data? If this function call is used for saving metadata right after saving the data file, this option should be used to make sure that the metadata file will match the dataset as well as possible.

silent

If silent, the metadata is not printed to the screen.

test

Nice for seeing what the meta data will look like. Problems will yield warnings, not errors.

debug

Start by calling browser()?

Value

The meta data object printed as formatted text

See Also

Other DataGen: metaCheck(), metaInit()


philipdelff/pmxtricks documentation built on Nov. 11, 2024, 5:16 p.m.