UtilOutputReport {RJafroc}

Generate a text formatted report file or an Excel file

Description

Generates a formatted report of the analysis and saves it to a text or an Excel file

Usage

UtilOutputReport(
  dataset,
  ReportFileBaseName = NULL,
  ReportFileExt = "txt",
  method = "DBM",
  FOM,
  alpha = 0.05,
  covEstMethod = "jackknife",
  nBoots = 200,
  sequentialNames = FALSE,
  overWrite = FALSE,
  analysisOption = "ALL"
)

Arguments

dataset

The dataset object to be analyzed (not the file name), see Dataset in RJafroc-package.

ReportFileBaseName

The report file (with extension "txt" or "xlsx", as specified by option ReportFileExt) is created in the user's directory. This argument specifies the report file base name (i.e., without the extension) for the desired report; the default is NULL, in which case the system generates a temporary text file, whose very long name is displayed. However, the file is very hard to locate. This is so that the software passes CRAN checks, as writing to the project directory, or any of its sub-directories, is frowned upon.

ReportFileExt

The report file extension determines the type of output. "txt", the default, for a text file, "xlsx" for an Excel file.

method

The significance testing method, "OR" or (the default) "DBM".

FOM

The figure of merit; see StSignificanceTesting.

alpha

See StSignificanceTesting; the default is 0.05.

covEstMethod

See StSignificanceTesting; only needed for method = "OR"; the default is "Jackknife".

nBoots

See StSignificanceTesting; only needed for "OR" analysis; the default is 200.

sequentialNames

A logical variable: if TRUE, consecutive integers (starting from 1) will be used as the treatment and reader IDs in the output report. Otherwise, treatment and reader IDs in the original dataset are used. This option is needed for aesthetics, as long names can mess up the output. The default is FALSE.

overWrite

A logical variable: if FALSE, a warning will be issued if the report file already exists and the program will wait until the user inputs "y" or "n" to determine whether to overwrite the existing file. If TRUE, the existing file will be silently overwritten. The default is FALSE.

analysisOption

"RRRC", "FRRC", "RRFC or "ALL"; see StSignificanceTesting.

Details

A formatted report of the data analysis is written to the output file in either text or Excel format.

Value

StResult The object returned by StSignificanceTesting.

Examples

 # text output is created in a temporary file
UtilOutputReport(dataset03, FOM = "Wilcoxon")
# Excel output is created in a temporary file
UtilOutputReport(dataset03, FOM = "Wilcoxon", ReportFileExt = "xlsx")