r2lh (version 0.6.1)

rtlu: ~ Function: R to LaTeX, Univariate analysis ~ ~ Function: R to HTML, Univariate analysis ~

Description

rtlu performs some basic analyses, then generates code to be included in a LaTeX document to print the analyses in a (so nice!) LaTeX way. rthu does the same but generates code in HTML format.

Usage

rtlu(x,fileOut="",textBefore="",textAfter="",graphDir="graphUniv",graphName="V",type="png",limDiscrete=10)

Arguments

x

[data.frame] or [vector] : contains the data to analyse.

fileOut

[character]; name of the output file in which the LaTeX or HTML summary will be saved. If empty, the code is printed on screen.

textBefore

[character] or [vector(character)] : before printing a variable analysis, some text can be inserted. If the function (rtlu or rthu) is applied on a single variable, textBefore should be of

textAfter

[character] or [vector(character)] : after printing a variable analysis, some text can be added. See textBefore and examples for details.

graphDir

[character] : subdirectory used to save the graphs generated by the analyses.

graphName

[character] or [vector(character)] : prefix for the graph names. If empty, the graph names are V1 to V length(data.frame)

type

[character] : type of plotting device used to export the graphics. Can be Windows metafile, PNG, JPEG, BMP (Windows bitmap format), TIFF, PostScript or PDF.

limDiscrete

Univariate analyses distinguish two kinds of numeric : discrete designates numeric variables with only a few modalities, continuous designates numeric variables with many mod

Value

• rtlu and rthu generate LaTeX or HTML code respectively. They either print it on the screen, or save it in a file. They also generate several graphs, optionally in a different directory.

Classical usage

The use of rtlu or rthu goes through the following steps: ll{ Step 1. Load the data (usually, a data.frame). Step 2. Optionally, set some variables as ordered. Step 3. Run rtlu(dataFrame,"fileOut.tex"). } See examples of application.

Author

Christophe Genolini [e-mail] PSIGIAM: Paris Sud Innovation Group in Adolescent Mental Health INSERM U669 / Maison de Solenn / Paris Bernard Desgraupes [e-mail] University of Paris Ouest - Nanterre

Details

rtlu performs some basic analyses, then generates a code to be included in a LaTeX document to print the analyses in a (so nice!) LaTeX way. rthu performs some basic analyses, then generates a code to be included in a HTML document. Both functions perform the analyses automatically according to the data class. They consider four classes. The analysis of the variable depends on the class:

1. factor, character and logical: Frequency ; Graph: barplot
2. ordered: Frequency, quartile ; Graph: barplot
3. numeric discrete: Frequency, mean, variance, quartile ; Graph: boxplot and barplot
4. numeric continuous: Mean, variance, quartile ; Graph: boxplot and histogram.

On a data.frame, rtlu and rthu run the analyses on every column.

References

LaTeX web site http://www.latex-project.org/ Data are available on line: http://christophe.genolini.free.fr/EPO/EPO2007-Fraude.php

See Also

rtlMainFile, rtlb, r2lUniv-package, examCheating, Sweave, latex

Examples

### Create some data
V1 <- factor(LETTERS[floor(runif(50,1,4))])
V2 <- rnorm(50,1,1)<0
V3 <- ordered(LETTERS[floor(runif(50,1,4))])

### Create a directory for the output
r2lhOutDir <- paste(tempdir(),"rtluExample",sep="/")
if(!file.exists(r2lhOutDir)){dir.create(r2lhOutDir)}
setwd(r2lhOutDir)

### Execute rtlu
rtlu(V1,fileOut="first.tex",textBefore="\\section{Variable 1 to 3}",graphName="V1")
rtlu(V2,fileOut="second.tex",graphName="V2")
rtlu(V3,fileOut="third.tex",textBefore="This is variable 3",graphDir="P")
rtlMainFile(text="\\input{first.tex}
\\input{second.tex}
\\input{third.tex}")



 # # # # # # # # # # # # # # # # # # #
#   R to LaTeX, Univariate Analyses   #
 #          Real examples            #
  #        rtlu data.frame          #
   # # # # # # # # # # # # # # # # #

########################
###### Step 1: Create the data

data(examCheating)
str(examCheating)

########################
###### Step 2: ordering variable

examCheating$YearOfStudy <- ordered(examCheating$YearOfStudy,levels=c("L1","L2","L3","M1","M2"))
examCheating$Bac <- ordered(examCheating$Bac,levels=c("Remedial exam","Pass","Fairly good","Good","Very good","Summa cum laude"))
for(iColumn in 8:17){
    examCheating[,iColumn] <- ordered(examCheating[,iColumn],levels=c("Never","Rarely","Sometimes","Often","Always"))
}
str(examCheating)


########################
###### Step 3: running rtlu

### The following code will create some files.
### So we first move to a directory.
r2lhOutDir <- paste(tempdir(),"rtluReal",sep="/")
if(!file.exists(r2lhOutDir)){dir.create(r2lhOutDir)}
setwd(r2lhOutDir)

### Then we prepare the textBefore, for transition between variables

textBefore <- paste("\\subsection{",names(examCheating)[c(2:5,18:20)],"}",sep="")

text <- "\\maketitle
\\tableofcontents
\\section{Survey}
  \\begin{enumerate}
    \\item What is your age?
    \\item What is your gender?
    \\item What is your level?
    \\item What is your field?
    \\item Did you cheat at Bac?
    \\item Did you cheat high scool?
    \\item Cheating score
  \\end{enumerate}
\\section{Univariate analysis}
  \\input{ExamCheat-univ.tex}

\\section{More information?}
For a detailled analysis, see
http://christophe.genolini.free.fr/EPO/2007 Fraude/EPO2007-Fraude-Rapport.pdf"

### We can run r2lu
rtlu(examCheating[,c(2:5,18:20)],fileOut="ExamCheat-univ.tex",textBefore=textBefore)
rtlMainFile("ExamCheat-main.tex",text=text)
setwd("../..")

### Then compile main.tex twice. It is ready !