codebook: Generic function to build a codebook from an R object

In jknowles/metaframe: Metadata for Dataframes

Description

Build an HTML codebook from an R object that includes metadata about the data stored in the object and its creation. For some object types it will include auto-generated summary information about the data in the fields.

Usage

codebook(object, file = NULL, replace = FALSE, render = FALSE)

## S3 method for class 'meta.data'
codebook(object, file = NULL, replace = FALSE,
  render = FALSE)

Arguments

object	a data object to construct a codebook for
file	a character string indicating where the file should be saved, if NULL default is 'codebook'
replace	logical, should an existing codebook file be overwritten, default is FALSE
render	logical, should the codebook be opened after it is written? default is FALSE

Value

An HTML file with codebook information

Author(s)

Carl Frederick

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