RJafroc (version 1.2.0)

UtilOutputReport: 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, dataDescription = "MyDataDescription: ",
  ReportFileBaseName = NULL, ReportFileExt = "txt", method = "DBMH",
  FOM = "Wilcoxon", alpha = 0.05, covEstMethod = "Jackknife",
  nBoots = 200, renumber = FALSE, overWrite = FALSE)

Arguments

dataset

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

dataDescription

A short string describing the dataset, the default is "MyDataDescription: "; it is inserted, for reference, in the output file.

ReportFileBaseName

The file bse name (sans extension) for the desired report; the default is NULL, in which case the system generates a temporary text file, whose name will be displayed. If an Excel file is desired, the extension should be ".xlsx"; if a text file output is desired, the extension should be ".txt".

ReportFileExt

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

method

The significance testing method, "ORH" or (the default) "DBMH".

FOM

The figure of merit; see StSignificanceTesting.

alpha

See StSignificanceTesting; the default is 0.05.

covEstMethod

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

nBoots

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

renumber

A logical variable: if TRUE, consecutive integers (staring from 1) will be used as the treatment and reader IDs in the output report. Otherwise, treatment and reader IDs in the original data file will be used. This option may be needed for aesthetics. 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.

Value

sigTestResult The object returned by StSignificanceTesting.

Details

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

Examples

# NOT RUN {
# }
# NOT RUN {
UtilOutputReport(dataset03) # text output is created in a temporary file

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

# }
# NOT RUN {
       
# }