File: writeReport.Rd

package info (click to toggle)
r-cran-nozzle.r1 1.1-1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 796 kB
  • sloc: javascript: 553; makefile: 12
file content (48 lines) | stat: -rw-r--r-- 1,552 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
\name{writeReport}
\alias{writeReport}
\title{Write \code{report} to file.}
\usage{
  writeReport(report, filename = DEFAULT.REPORT.FILENAME,
    debug = FALSE, output = c(HTML.REPORT, RDATA.REPORT),
    credits = TRUE, level = PROTECTION.PUBLIC,
    debugCss = NA, debugJavaScript = NA)
}
\arguments{
  \item{report}{The report to be written.}

  \item{filename}{Name of the output file without file
  extension.}

  \item{debug}{If TRUE, external CSS (\code{debugCss}) and
  JavaScript (\code{debugJavaScript}) can be supplied.}

  \item{output}{A list of output formats. Any combination
  of HTML.REPORT and RDATA.REPORT is allowed.}

  \item{credits}{If TRUE, a note and a link will be
  included at the bottom of the report to indicate that it
  was created with Nozzle.}

  \item{level}{The protection level of the report. If set
  to PROTECTION.PUBLIC only elements with protection level
  PROTECTION.PUBLIC (default) will be included in the
  report. If set to PROTECTION.GROUP, then all elements
  with protection level PROTECTION.PUBLIC and
  PROTECTION.GROUP will be included. If set to
  PROTECTION.PRIVATE all elements will be included.}

  \item{debugCss}{A path or URL to a CSS file that should
  be used instead of the built-in CSS. Only used if
  \code{debug} is TRUE.}

  \item{debugJavaScript}{A path or URL to a JavaScript file
  that should be used instead of the built-in JavaScript.
  Only used if \code{debug} is TRUE.}
}
\description{
  Write \code{report} to file.
}
\author{
  Nils Gehlenborg \email{nils@hms.harvard.edu}
}