r2lUniv.Rclasses {r2lUniv}R Documentation

Methods for R classes

Description

Methods used by r2lUniv for factor, logical, ordered, integer and numeric.

On these variables, r2lUniv chooses the r2lUniv basic classes corresponding then runs the r2lUniv basic analyses.

Usage

## S3 method for class 'factor':
r2lUniv(data, fileOutput = "", varName = NA, varNumber = NA, dirGraph = "", graphName = "V",...)
## S3 method for class 'logical':
r2lUniv(data, fileOutput = "", varName = NA, varNumber = NA, dirGraph = "", graphName = "V",...)
## S3 method for class 'ordered':
r2lUniv(data, fileOutput = "", varName = NA, varNumber = NA, dirGraph = "", graphName = "V",...)
## S3 method for class 'integer':
r2lUniv(data, fileOutput = "", varName = NA, varNumber = NA, dirGraph = "", graphName = "V", limDiscrete = 10,...)
## S3 method for class 'numeric':
r2lUniv(data, fileOutput = "", varName = NA, varNumber = NA, dirGraph = "", graphName = "V", limDiscrete = 10,...)

Arguments

data vector; to print
fileOutput character; name of the output file to save the LaTeX code. If empty, code is printed on screen.
varName character, single; title of the LaTeX summary. For no title, use NA instead of "".
varNumber numeric, single; number to be printed before the title. For no number, use NA instead of "".
dirGraph character; Directory used to save the graphs generated by the analyses.
graphName character, single; Prefix of the graphs' names. The full names of the graphs will be graphName with a postfix in ("-boxplot.eps", "-barplot.eps", "-hist.eps")
limDiscrete numeric; Fixes the limit that distinguishes continuous variables from discrete ones. See r2lFindClass for details.
... For S3 compatibility only

Details

On a variable with standard R class, r2lUniv chooses the r2lUniv basic classes corresponding to the R class then runs the r2lUniv basic analyses.

The r2l basic class of the variable is first set by the r2lFindClasses.

Then r2lUniv is called. See r2lUniv.r2lBasicClasses for what happens next.

Value

See r2lUniv.r2lBasicClasses for details.

Author

Christophe Genolini
christophe.genolini@free.fr
PSIGIAM: Paris Sud Innovation Group in Adolescent Mental Health
INSERM U669 / Maison de Solenn / Paris

English correction

Jean-Marc Chamot
jchamot@u-paris10.fr
Laboratoire "Sport & Culture" / "Sports & Culture" Laboratory
University of Paris 10 / Nanterre

References

LaTeX web site http://www.latex-project.org/

See Also

Sweave, latex, r2lUniv, r2lConcepts, r2lUniv.r2lBasicClasses, r2lUniv.data.frame, r2lFindClass

Examples

 # # # # # # # # # # # # # # # # # # #
#   R to LaTeX, Univariate Analyses   #
 #             Examples              #
  #           R  classes            #
   # # # # # # # # # # # # # # # # #

########################
###### Load the data

data(Vfactor)
data(Vlogical)
data(Vordered)
data(Vinteger)
data(Vnumeric)

########################
###### Run r2lUniv

### The following code will create some files.
### We advise you to first move to directory "r2lUnivExample"
dir.create("r2lUnivExample")
setwd("r2lUnivExample")
dir.create("graph")

### Univariate analyses
r2lUniv(Vfactor,"factor.tex")
r2lUniv(Vlogical,"logical.tex",varName="RepeatingYear",graphName="L")
r2lUniv(Vordered,"ordered.tex",varNumber="3",graphName="O")
r2lUniv(Vinteger,"integer.tex",varName="Age",varNumber="4",graphName="I")
r2lUniv(Vnumeric,"numeric.tex",varName="CheatScore",varNumber="5",graphName="N",dirGraph="graph")

### Creates the main document.
r2lGenerateLatexMain(c("factor.tex","logical.tex","ordered.tex","integer.tex","numeric.tex"))

### Everything is ready, you can now run LaTeX on the file "main.tex"
setwd("..")

[Package r2lUniv version 0.9 Index]