cdbkTxt: Printing objects to plain text format

In mbojan/cdbk-old: Automated documentation of datasets

Description

Printing objects to plain text format.

Usage

cdbkTxt(object, ...)
## S4 method for signature 'cdbkData'
cdbkTxt(object, file="", append=FALSE,
  title="Dataset documentation")
## S4 method for signature 'cdbkTech'
cdbkTxt(object, file="", append=FALSE, ...)
## S4 method for signature 'list'
cdbkTxt(object, ...)

Arguments

object	R\ object, see Details and Methods
file	character or a connection to write the documentation to, passed to cat
append	logical, only used if file is character naming the file, whether to append to a file or start from the beginning
title	character, header for the codebook
...	other arguments to/from other methods

Details

This generic function creates a plain text representation of the documentation objects.

Value

Nothing, but the text is printed to a file or console.

Methods

object = "cdbkData"

The method prints the data documentation object. First the data level information from the object and then proceeds through the list of the variable objects and prints them subsequently.

object = "cdbkTech"

Writes the technical summary of a variable. It starts with a header and then prints the rest in tabular form.

object = "list"

When called on a list the method is applied to all the components of the list.

See Also

Class description cdbkTech

Examples

# TODO add examples

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