relax is an editor for doing data analysis with R and writing reports.
redit is a simple version of relax offering a reduced set of items in the head menus.
red is an other name for redit.
relax(file.name, no.plots = FALSE, cmds = "", but.Wizardry = "all") redit(file.name) red(file.name)TRUE no plots are integrated into the report text field"all" menu Wizardry is created;
if "simple" a reduced list of commands is offered relax is written in R and Tcl/Tk.
relax creates a new window (top level Tcl/Tk widget) that consists of
two text fields and some buttons and menus. Text (chunks) and code (chunks)
are inserted in the upper text field (report field). Code chunks are evaluated by clicking
on EvalRCode. Results are shown in the lower text field (output field) and will be
transferred to the report field by pressing on Insert. Chunks are separated by separators:
A line containing the character "@" at its first position indicades the beginning of a text chunk.
Patterns like <<*>>= or <<code chunk name>>= define code chunk
headers and introduce code chunks.
The code of a code chunk is the set of R expression found between the header and the
following text chunk.
redit is a wrapper function that calls relax with argument but.Wizardy="simple".
How to work with relax?
relax by: library(relax).
relax().
PlanRCode: Press PlanRCode and an empty text chunk and an empty code
chunk without contents appear in the report field (upper blue text field).
Now you can write down any text between
"@"-line and the header of next code chunk <<*>>=. The code has to be placed
after the header line.
EvalRCode: EvalRCode evaluates the code (the cursor is pointing at)
and the results appear in the output field just as in R;
warnings will be converted in errors and will stop the evaluation.
WarnEval: WarnEval evaluates the code (the cursor is pointing at)
and the results appear in the output field just as in R;
however warnings will not stop the evaluation of the code.
RemoveOut: RemoveOut clears the output field.
Insert: Insert transfers the contents of the output text field
to the upper text field as a new text chunk.
SavePlot: SavePlot copies the graphics device; it creates a postscript
as well as a jpeg file and inserts the LaTeX includegraphics reference
in the report field as a new text chunk.
Find: Find finds some text string in the working text and highlights
matches found.
TrashOutput: TrashOutput removes inserted R output from the upper field
(the cursor is pointing at).
Down: Down moves the cursor down to the next code chunk.
Up: Up moves the cursor up to the next code chunk.
File: The File menu in the menu bar of relax allows you save the report
-- the contents of the blue text field. The saving operation generates two
files: a text file (extension: rev) and a html file.
You can load an old report into the upper text field (report field)
and continue to work on the report.
Edit: Several operations to make editing faster and easier are collected in the Edit menu:
searching, starting an external editor, etc.
Options: The entries of the Options menu change some of the parameter of relax.
Wizardry: The items of Wizardry allow you to generate LaTeX documents from your
source file (for LaTeXperts only).
After saving the raw report you can web it: this process generates a tex-file
that can be formated by LaTeX. See your LaTeX companion for syntax.
(The web syntax fits to the rules of noweb.
Therefore, the raw files can also be processed by Norman Ramsey's
noweb system (see: http://www.eecs.harvard.edu/~nr/noweb/).
Configuration:
Important parameters of relax are set in the file ...relax/config/settings.relax.
Environment for evaluation:
Evaluations of code chunks take place in the environment (revive.env).
cmds:
The character vector cmds in environment (revive.env) enables you to
define operations of your own. For example, cmds<-"r test1.rev" forces relax
to load file test1.rev. cmds<-c("> 1+1","> 2+2") results in
computing 1+1 and then 2+2. cmds<-"s10" evaluates code chunk number 10.
### at first try:
# > redit()
### or
# > relax()
### If you want to start with some old file use:
# > redit("name of old rev-file")
### or
# > relax("name of old rev-file")
Run the code above in your browser using DataLab