document: Generic function to build a meta.data object

In jknowles/metaframe: Metadata for Dataframes

Description

Define and describe meta.data for a data object in R. Based on the object structure this function will automatically define some attributes of the data.

Usage

document(data, metadata = NULL, sources = NULL, units = NULL,
  labels = NULL, notes = NULL, revisions = NULL, ...)

## S3 method for class 'data.frame'
document(data, metadata = NULL, sources = NULL,
  units = NULL, labels = NULL, notes = NULL, revisions = NULL, ...)

## S3 method for class 'data.table'
document(data, metadata = NULL, sources = NULL,
  units = NULL, labels = NULL, notes = NULL, revisions = NULL, ...)

Arguments

data	a data object to define metadata for
metadata	a meta.data object to use for documentation
sources	a list of charcter strings describing data sources
units	a list of character strings describing units for the columns
labels	a list of character strings providing long variable names and labels
notes	a list of character strings with additional notes about variables
revisions	a list of character strings with information about revisions to a variable
...	optional additional parameters to meta.data.summary

Details

The object has the following items

• sources - a list of character strings describing data sources

• units - a list of character strings specifying the units of variables

• labels - a generic character string describing an object

• notes - character strings describing any additional details about specific data elements

• revisions - a list of data revisions

Value

A meta.data object

Note

Yadda yadda yadda

Author(s)

Jared E. Knowles

jknowles/metaframe documentation built on May 19, 2019, 11:43 a.m.