document: Generic function to build a meta.data object

Description Usage Arguments Details Value Note Author(s)

View source: R/document.R

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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

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.