relax                 package:relax                 R Documentation

_R _e_d_i_t_o_r: _r_e_l_a_x

_D_e_s_c_r_i_p_t_i_o_n:

     'relax' is an editor for doing data analysis with R and writing
     reports.

_U_s_a_g_e:

     relax(file.name, no.plots = FALSE, cmds = "", but.Wizardry = TRUE)

_A_r_g_u_m_e_n_t_s:

file.name: name of report file to be loaded 

no.plots: if 'TRUE' no plots are integrated into the report text field

    cmds: special operations that are evaluated on start 

but.Wizardry: if 'FALSE' menu 'Wizardry' is not created 

_D_e_t_a_i_l_s:

     '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 transfered 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.

     How to work with relax?

   _L_o_a_d _o_f _p_a_c_k_a_g_e '_r_e_l_a_x' in 'R' through: 'library(relax)'.

   _S_t_a_r_t _t_h_e _e_d_i_t_o_r _b_y: 'relax()'.

   _P_l_a_n_R_C_o_d_e: 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.

   _E_v_a_l_R_C_o_d_e: 'EvalRCode' evaluates the code (the cursor is pointing
        at) and the results appear in the output field just as in 'R'.

   _R_e_m_o_v_e_O_u_t: 'RemoveOut' clears the output field.

   _I_n_s_e_r_t: 'Insert' transfers the contents of the output text field to
        the upper text field as a new text chunk.

   _S_a_v_e_P_l_o_t: '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.

   _T_r_a_s_h_O_u_t_p_u_t: 'TrashOutput' removes inserted 'R' output from the
        upper field (the cursor is pointing at). 

   _D_o_w_n: 'Down' moves the cursor down to the next code chunk.

   _U_p: 'Up' moves the cursor up to the next code chunk.

   _F_i_l_e: 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.

   _E_d_i_t: Several operations to make editing faster and easier are
        collected in the 'Edit' menu: searching, starting an external
        editor, etc.

   _O_p_t_i_o_n_s: The entries of the 'Options' menu change some of the
        parameter of relax.

   _W_i_z_a_r_d_r_y: With 'Wizardry' you are able to generate LaTeX documents
        (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: 
         <URL: http://www.eecs.harvard.edu/~nr/noweb/>).

   _C_o_n_f_i_g_u_r_a_t_i_o_n: Some parameters of 'relax' can be modified in
        '...relax/config/settings.relax'.

   _E_n_v_i_r_o_n_m_e_n_t _f_o_r _e_v_a_l_u_a_t_i_o_n: Evaluations of code chunks take place in
        the environment ('revive.env').

   _c_m_d_s: 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.

_V_a_l_u_e:

     -

_N_o_t_e:

_A_u_t_h_o_r(_s):

     2005 Hans Peter Wolf

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://www.wiwi.uni-bielefeld.de/~wolf/software/relax/relax.html>

_S_e_e _A_l_s_o:

_E_x_a_m_p_l_e_s:

     ## The function is currently defined as
     function (workname.sys = "out.rev", no.plots = FALSE, cmds = "", but.Wizardry = TRUE){
           # nearly 5000 lines of R / Tcl/Tk code
     }

