report {svViews}R Documentation

Send a View to the report

Description

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.

Usage

    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", ...)

Arguments

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

Details

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")

Value

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

Author(s)

Eric Lecoutre & Philippe Grosjean

See Also

view

Examples

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

[Package svViews version 0.9-5 Index]