tangleR                package:relax                R Documentation

_f_u_n_c_t_i_o_n _t_o _t_a_n_g_l_e _a _f_i_l_e

_D_e_s_c_r_i_p_t_i_o_n:

     'tangleR' reads a file that is written according to the rules of
     the 'noweb' system and performs a specific kind of tangling. As a
     result a '.R'-file is generated.

_U_s_a_g_e:

     tangleR(in.file, out.file, expand.roots = NULL,
     expand.root.start = TRUE)

_A_r_g_u_m_e_n_t_s:

 in.file: name of input file 

out.file: name of output file; if missing the extension of the input
          file is turned to '.R' 

expand.roots: name(s) of root(s) to be expanded; if NULL all will be
          processed 

expand.root.start: if TRUE (default) root chunk "start" will be
          expanded 

_D_e_t_a_i_l_s:

     General remarks: A 'noweb' file consists of a mixture of text and
     code chunks. An '@' character (in column 1 of a line) indicates
     the beginning of a text chunk. '<<name of code chunk>>=' (starting
     at column 1 of a line) is a header line of a code chunk with a
     name defined by the text between '<<' and '>>='. A code chunk is
     finished by the beginning of the next text chunk. Within the code
     chunk you can use other code chunks by referencing them by name (
     for example by: '<<name of code chunk>>' ). In this way you can
     separate a big job in smaller ones.

     Special remarks: 'tangleR' expands code chunk 'start' if flag
     'expand.root.start' is TRUE. Code chunks will be surrounded by
     comment lines showing the number of the code chunk the code is
     coming from. If you want to use '<<' or '>>' in your code  it may
     be necessary to escape them by an '@'-sign. Then you have to type
     in: '@<<' or '@>>'.

_V_a_l_u_e:

     usually a file with R code is generated

_A_u_t_h_o_r(_s):

     Hans Peter Wolf

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://www.eecs.harvard.edu/~nr/noweb/intro.html>

_S_e_e _A_l_s_o:

     'weaveR'

_E_x_a_m_p_l_e_s:

     ## Not run: 
     ## This example cannot be run by examples() but should be work in an interactive R session
       tangleR("testfile.rev")
     ## End(Not run)
     "tangleR(\"testfile.rev\")"
     ## The function is currently defined as
     function(in.file,out.file,expand.roots=NULL,expand.root.start=TRUE){
     # german documentation of the code:
     # look for file webR.pdf, P. Wolf 050204
     ...
       }

