Description Usage Arguments Details Value Note Author(s)
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.
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, ...)
|
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 |
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
A meta.data
object
Yadda yadda yadda
Jared E. Knowles
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.