Create Report (PDF, PS, HTML, or XML) File Representation of a Set of Data Frame Columns
DESCRIPTION:
This function creates a summary report and writes the report to a file in
one of the following formats: PDF, PS, HTML, or XML.
USAGE:
summaryReport(data, file, variables=c(), grouping.variables=c(),
mean=T, median=T, stdev=T, range=T, quartile=T, st.error=T,
missing=T, precision=2, nbins=5, minLevels=5, type=NULL,
xslFile=NULL, title="", maxColumnsPerTable=0,
loggingLevel=4)
ARGUMENTS:
- data
-
the object to be reported. Must be compatible with data.frame.
- file
-
desired output file location
- variables
-
a character array that defines the reported variables. The default value is all non-grouping columns in data.
- grouping.variables
-
a character array that defines the grouping columns.
- mean
-
allows user to include/exclude mean from numeric report.
- median
-
allows user to include/exclude median from numeric report.
- stdev
-
allows user to include/exclude standard deviation from numeric report.
- range
-
allows user to include/exclude range from numeric report.
- quartile
-
allows user to include/exclude quartile from numeric report.
- st.error
-
allows user to include/exclude standard error from numeric report.
- missing
-
allows user to include/exclude missing row count from numeric report.
- precision
-
allows user to set the number of decimal places displayed in report.
- nbins
-
allows user to set the number of bins a numeric grouping variable will be cut into.
- minLevels
-
allows user to set the minimum number of unique values a numeric grouping variable must have before being cut.
- type
-
type of report to generate: "pdf", "ps", "html", or "xml". If type is unset, the filename extension will define the output format.
- xslFile
-
specify the XSL file to use. The default ColumnReport.xsl or ColumnReport_FO.xsl is used if
xslFile
is not specified.
- title
-
specify the report title.
- maxColumnsPerTable
-
allows user to control the width of the report by specifying the maximum number of data columns allowable. Anything less than 1 is ignored and all columns are displayed.
- loggingLevel
-
allows user to control the warnings and errors reported by the XSL transformation.
VALUE:
None
EXAMPLES:
summaryReport(fuel.frame, "object.pdf", range=F, precision=5)
summaryReport(fuel.frame, "FuelByWeight.pdf", variables="Fuel",
grouping.variables="Weight", nbins=5, minLevels=10,
title="Fuel by Weight", maxColumnsPerTable=2)