report                package:svViews                R Documentation

_S_e_n_d _a _V_i_e_w _t_o _t_h_e _r_e_p_o_r_t

_D_e_s_c_r_i_p_t_i_o_n:

     Given a SciViews-compatible reporting application (like SciViews R
     Report or Microsoft Word) is parameterized as the default
     application to use, this function generates and append a View to
     the current report.

_U_s_a_g_e:

         report(x, objname = deparse(substitute(x)), reptype = getOption("report"),
           application = getOption("reporter"), bookmark = "<End>", ...)
         reportGraph(device = dev.cur(), reptype = getOption("report"),
           application = getOption("reporter"), bookmark = "<End>", multiformat = FALSE,
           dir = file.path(tempdir(), "svGraph"), width = 480, height = 480,
           pointsize = 12, bg = "transparent", ...)

_A_r_g_u_m_e_n_t_s:

       x: An object 

 objname: A name for this object (its own name, by default) 

 reptype: The type of report. By default, it is '"html"' format. An
          alternative is '"doc"' for a Microsoft Word report 

  device: The device where the graph should be appended to the report 

application: The reporter application, in case of 'reptype == "html"' 

bookmark: A bookmark to select in a Word document before pasting the
          data. If '"<End>"' (by default), the end of the document is
          selected (data is appended). If 'NULL', then a GoTo dialog
          box is first displayed in Word to select a location before
          pasting. If a string is given, it must match a valid bookmark
          in the active Word document, otherwise an error will be
          issued. 

multiformat: Do we use multiple formats (PNG + PDF, currently), or not
          (PNG only, default value) 

     dir: The directory where to place resulting files 

   width: The width of the generated image, in pixels 

  height: The height of the generated image, in pixels 

pointsize: The pointsize (font size) to use 

      bg: The color of the background (transparent, by default) 

     ...: Further argument to use to generate the View or the graph 

_D_e_t_a_i_l_s:

     'ReportGraph()' prepares graph outputs, so that they are suitable
     to be incorporated in a report. For an HTML report, it is a PNG
     image (plus a PDF one, if 'multiformat = TRUE'). You can specify
     an option to tell which type of report is used by default: define
     'options(report = "html")' (used by default) or 'options(report =
     "doc")'. For an '"html"' type, you need also to give the path to a
     compatible application like SciViews R Report. You can indicate it
     with 'options(reporter = "path_to_the_app")'

_V_a_l_u_e:

     Returns invisibly 'TRUE' for 'report()' and the path to the
     created PNG/EMF file for 'reportGraph'.

_A_u_t_h_o_r(_s):

     Eric Lecoutre & Philippe Grosjean

_S_e_e _A_l_s_o:

     'view'

_E_x_a_m_p_l_e_s:

         ## Not run: 
             data(iris)
             report(iris)
         
     ## End(Not run)

