returnVariableDescription {CoCoRaw}R Documentation

Return the specification of the data in the CoCo object

Description

Return the specification of the data in the CoCo object in form of variable names, number of levels, number of levels marked as missing value and type of variable.

Usage

returnVariableDescription(full = FALSE, levels = TRUE, 
                          missing.levels = TRUE, data = NULL, 
                          object = .object.of.thing(data = data, ...), ...)

Arguments

full Logical, if full is TRUE then the number of specified variables is returned, that is number without setUseVariables.
levels Logical, if levels is TRUE then return the number of levels.
missing.levels Logical, if missing.levels is TRUE then return the number of levels marked as missing.
data See exportCoCo.
object See exportCoCo.
... Additional arguments to generate the CoCo object from the data argument. See propertyModel.

Value

A list with the components

names chr
labels NULL
types int
stratum NULL
levels int
missing.levels int

Author(s)

Jens Henrik Badsberg

References

Badsberg, J.H.: A guide to CoCo, JSS, 2001 ( http://www.jstatsoft.org/v06/i04/ ) and Badsberg, J.H.: Xlisp+CoCo, Aalborg University, 1996.

See Also

forward.

Examples

 
library(CoCo);
data(Reinis);
CoCoObject <- makeCoCo();
enterTable(Reinis, object = CoCoObject);

showOptions("specification", object = CoCoObject);
Specification <- returnVariableDescription(object = CoCoObject);
Specification

endCoCo(object = CoCoObject);

# - - - - -  - - - - -  - - - - -  - - - - -  - - - - -  - - - - -  - - - - - #

library(CoCoCg);
data(Rats);
CoCoObject <- makeCoCoCg();
enterDataFrame(Rats, object = CoCoObject);

numberVariates(object = CoCoObject);
numberVariates(full = TRUE, object = CoCoObject);

endCoCo(object = CoCoObject);

# - - - - -  - - - - -  - - - - -  - - - - -  - - - - -  - - - - -  - - - - - #

library(CoCo);
data(Byssinosis38);
CoCoObject <- makeCoCo();
enterTable(Byssinosis38, object = CoCoObject);

numberVariates(object = CoCoObject);

endCoCo(object = CoCoObject);

[Package CoCoRaw version 0.1.6.8 Index]