RweaveLatex              package:tools              R Documentation

_R/_L_a_T_e_X _D_r_i_v_e_r _f_o_r _S_w_e_a_v_e

_D_e_s_c_r_i_p_t_i_o_n:

     A driver for `Sweave' that translates R code chunks in LaTeX
     files.

_U_s_a_g_e:

     RweaveLatex()
     RweaveLatexSetup(file, syntax, output=NULL, quiet=FALSE, debug=FALSE,
                      echo=TRUE, eval = TRUE, split=FALSE, stylepath=TRUE,
                      pdf=TRUE, eps=TRUE)

_A_r_g_u_m_e_n_t_s:

    file: Name of Sweave source file.

  syntax: An object of class `SweaveSyntax'.

  output: Name of output file, default is to remove extension `.nw',
          `.Rnw' or `.Snw' and to add extension `.tex'. Any  directory
          names in `file' are also removed such that the output is
          created in the current working directory.

   quiet: If `TRUE' all progress messages are suppressed.

   debug: If `TRUE', input and output of all code chunks is copied to
          the console.

stylepath: If `TRUE', a hard path to the file `Sweave.sty' installed
          with this package is set, if `FALSE', only
          `\usepackage{Sweave}' is written. The hard path makes the TeX
          file less portable, but avoids the problem of installing the
          current version of `Sweave.sty' to some place in your TeX
          input path. The argument is ignored if a
          `\usepackage{Sweave}' is already present in the Sweave source
          file. 

    echo: set default for option `echo', see defails below.

    eval: set default for option `eval', see defails below.

   split: set default for option `split', see defails below.

     pdf: set default for option `pdf', see defails below.

     eps: set default for option `eps', see defails below.

_S_u_p_p_o_r_t_e_d _O_p_t_i_o_n_s:

     RweaveLatex supports the following options for code chunks (the
     values in parentheses show the default values):

     _e_c_h_o: logical (`TRUE'). Include S code in the output file?

     _e_v_a_l: logical (`TRUE'). If `FALSE', the code chunk is not
          evaluated, and hence no text or graphical output produced.

     _r_e_s_u_l_t_s: character string (`verbatim'). If `verbatim', the output
          of S commands is included in the verbatim-like Soutput
          environment. If `tex', the output is taken to be already
          proper latex markup and included as is. If `hide' then all
          output is completely suppressed (but the code executed during
          the weave).

     _p_r_i_n_t: logical (`FALSE') If `TRUE', each expression in the code
          chunk is wrapped into a `print()' statement before
          evaluation, such that the values of all expressions become
          visible.

     _t_e_r_m: logical (`TRUE'). If `TRUE', visibility of values emulates
          an interactive R session: values of assignments are not
          printed, values of single objects are printed. If `FALSE',
          output comes only from explicit `print' or `cat' statements.

     _s_p_l_i_t: logical (`FALSE'). If `TRUE', text output is written to
          seperate files  for each code chunk.

     _s_t_r_i_p._w_h_i_t_e: logical (`TRUE'). If `TRUE', blank lines at the
          beginning and end of output are removed.

     _p_r_e_f_i_x: logical (`TRUE'). If `TRUE' generated filenames of figures
          and output have a common prefix.

     _p_r_e_f_i_x._s_t_r_i_n_g: a character string, default is the name of the
          `.Snw' source file.

     _i_n_c_l_u_d_e: logical (`TRUE'), indicating whether input statements for
          text output and includegraphics statements for figures should
          be auto-generated. Use `include=FALSE' if the output should
          appear in a different place than the code chunk (by placing
          the input line manually).

     _f_i_g: logical (`FALSE'), indicating whether the code chunk produces
           graphical output. Note that only one figure per code chunk
          can be processed this way.

     _e_p_s: logical (`TRUE'), indicating whether EPS figures shall be
          generated. Ignored if `fig=FALSE'. 

     _p_d_f: logical (`TRUE'), indicating whether PDF figures shall be
          generated. Ignored if `fig=FALSE'.

     _w_i_d_t_h: numeric (6), width of figures in inch.

     _h_e_i_g_h_t: numeric (6), height of figures in inch.

_A_u_t_h_o_r(_s):

     Friedrich Leisch

_R_e_f_e_r_e_n_c_e_s:

     Friedrich Leisch: Sweave User Manual, 2002
     <URL: http://www.ci.tuwien.ac.at/~leisch/Sweave>

_S_e_e _A_l_s_o:

     `Sweave', `Rtangle'

