RJafroc (version 1.3.2)

DfReadDataFile: Read a data file

Description

Read a disk file and create a dataset object from it.

Usage

DfReadDataFile(
  fileName,
  format = "JAFROC",
  newExcelFileFormat = FALSE,
  delimiter = ",",
  sequentialNames = FALSE
)

Arguments

fileName

A string specifying the name of the file. The file-extension must match the format specified below

format

A string specifying the format of the data in the file. It can be "JAFROC" (the default), "MRMC" or "iMRMC". For "MRMC" the format is determined by the data file extension as specified in http://perception.radiology.uiowa.edu/, i.e., .csv or .txt or .lrc. For file extension .imrmc the format is described in https://code.google.com/p/imrmc/.

newExcelFileFormat

This argument only applies to the "JAFROC" format. The default is FALSE. if TRUE the function accommodates 3 additional columns in the Truth worksheet. If FALSE, the original function, as in version 1.2.0 is used, and the three extra columns, if present, throws an error.

delimiter

The string delimiter to be used for the "MRMC" format ("," is the default), see http://perception.radiology.uiowa.edu/. This parameter is not used when reading "JAFROC" or "iMRMC" data files.

sequentialNames

A logical variable: if TRUE, consecutive integers (starting from 1) will be used as the treatment and reader IDs (i.e., names). Otherwise, treatment and reader IDs in the original data file will be used.

Value

A dataset with the structure specified in RJafroc-package.

Examples

# NOT RUN {
fileName <- system.file("extdata", "toyFiles/ROC/rocCr.xlsx", 
package = "RJafroc", mustWork = TRUE)
x <- DfReadDataFile(fileName, newExcelFileFormat = TRUE)

{
fileName <- system.file("extdata", "toyFiles/FROC/frocCr.xlsx", 
package = "RJafroc", mustWork = TRUE)
x <- DfReadDataFile(fileName, newExcelFileFormat = TRUE)
}

# }
# NOT RUN {
fileName <- system.file("extdata", "RocData.xlsx", 
package = "RJafroc", mustWork = TRUE)
RocDataXlsx <- DfReadDataFile(fileName)

fileName <- system.file("extdata", "RocData.csv", 
package = "RJafroc", mustWork = TRUE)
RocDataCsv<- DfReadDataFile(fileName, format = "MRMC")

fileName <- system.file("extdata", "RocData.imrmc", 
package = "RJafroc", mustWork = TRUE)
RocDataImrmc<- DfReadDataFile(fileName, format = "iMRMC")

fileName <- system.file("extdata", "FrocData.xlsx", 
package = "RJafroc", mustWork = TRUE)
FrocDataXlsx <- DfReadDataFile(fileName, sequentialNames = TRUE)
# }
# NOT RUN {
# }