vardef: Create a VariableDef object

Description Usage Arguments Author(s) See Also

View source: R/VariableDef.R

Description

Constructor of the VariableDef class. A VariableDef object stores all the data needed to process a variable in the package.

Usage

1
2
3
vardef(originalname = NULL, varlabel = NULL, description = NULL,
  rname = NULL, type = "not_used", comment = NULL, unit = NULL,
  levels = NULL, names = NULL)

Arguments

originalname

character The original name of the variable in the raw data table.

varlabel

A character. Used to label properly the plots and tables in output.

description

A character. A description of the variable

rname

A character. It's the name of the variable used in R.

type

A character. Must be one of the following : numeric, integer, factor, ordered, character, date or not_used.

comment

A character.

unit

A character. Could be used for the format of a date (by default aa/mm/yyyy).

levels

A character vector. Describe the levels used for a vector.

names

A character vector of the same size than number of levels or empty.

Author(s)

Joris Muller

See Also

VariableDef-class and DatabaseDef-class


jomuller/vartors documentation built on May 19, 2019, 7:26 p.m.