cdbk-package: Package 'cdbk': Automated documentation of datasets

In mbojan/cdbk-old: Automated documentation of datasets

Description

This package implement a simple system for producing publication-ready documentation of a data set (aka codebooks). Implemented functions enable producing documents that include summary information for all the variables in the given data set. The package supports producing codebooks in plain text, HTML as well as LaTeX formats. The flexible design of the system enables the user to define their own ways the data are summarized in the document by supplying user-programmed classes and methods that extend the currently defined ones.

Details

The package provides a schema of S4 classes and methods to produce dataset documentation. First, all classes defined in this package extend a virtual “master class” cdbkObject:

• Members of sub-class cdbkDf are designed to store data-level summaries like number of variables, number of cases, number of complete cases etc.

• Members of sub-class cdbkVar are designed to store variable-level summaries like length, number of missing values, mean, minimum and maximum, etc.

These classes can be extended by the user to create objects that will contain any information that one might need.

There is a collection of generic functions for these three basic classes that actually compute the neccessary information from the data. For example the generic varTech creates simple “technical“ summary of a variable.

Finally there is a collection of methods for printing these summary objects. Currently only printing to plain text is supported with methods for the generic show. There are plans for providing functions for writing HTML and LaTeX code as well.

Author(s)

This package is written and maintained by

Michal Bojanowski [e-mail]

See Also

Similar functionality is also available in the memisc package.

Examples

# example data frame
d <- data.frame( n = 1:5, # numeric variable
  ch = letters[1:5], # character variable
  f = factor(letters[6:10]), # factor
  i = as.integer(1:5) ) # integer variable

# make a summary of individual variable
o <- varTech(d$n)
o

# make a global sumary of the dataset
o <- dfTech(d)
o

# make a documentation object for the whole dataset
# TODO

mbojan/cdbk-old documentation built on Dec. 21, 2021, 3:56 p.m.