compareProjectToStoredOutputFiles: Function for comparing existing output files with the memory...

In StoXProject/RstoxFramework: The Engine of StoX

Function for comparing existing output files with the memory read using runProject()

Description

Function for comparing existing output files with the memory read using runProject()

Usage

compareProjectToStoredOutputFiles(
  projectPath,
  projectPath_original = projectPath,
  emptyStringAsNA = FALSE,
  intersect.names = TRUE,
  ignore = NULL,
  skipNAFraction = FALSE,
  skipNAAt = FALSE,
  NAReplacement = NULL,
  ignoreEqual = FALSE,
  classOf = c("first", "second"),
  try = TRUE,
  data.out = FALSE,
  mergeWhenDifferentNumberOfRows = FALSE,
  sort = TRUE,
  compareReports = FALSE,
  checkOutputFiles = TRUE,
  tolerance = sqrt(.Machine$double.eps),
  debug = FALSE,
  save = FALSE,
  ...
)

Arguments

projectPath	The project to be run and tested against the existing output files of the project gievn by projectPath_original.
projectPath_original	The project holding the existing output files, defaulted to projectPath.
emptyStringAsNA	Logical: If TRUE, read empty strings as NA from the stored original tables, as RstoxFramework has started writing NAs as NAs and not as empty strings.
intersect.names	Logical: If TRUE, compare only same named columns.
ignore	A vector of names of columns to ignore in all.equal().
skipNAFraction	Logical: If TRUE, skip rows with more than 50 percent NAs. Can be set to a value between 0 and 1.
skipNAAt	A vector of strings naming the columns in which NA values identifies rows to skip.
NAReplacement	List of replacement values for different classes of NA, applied after any merging as to incorporate NAs generated during merging.
ignoreEqual	Logical: If TRUE, ignore columns where all values are equal.
classOf	Character string specifying whether to compare after converting to the class of the first or second table. Set this to "first" (default) to convert class to the original data.
try	Logical: If FALSE do not run the process in a tryCatch. Set this to FALSE when debugging, as the tryCatch masks the errors in the traceback.
data.out	Logical, if TRUE output the original and new data along with the tests.
mergeWhenDifferentNumberOfRows	Logical, if TRUE use all.equal_mergeIfDifferentNumberOfRows instead of all.equal.
sort	Logical, if TRUE sort the tables before all.equal. When mergeWhenDifferentNumberOfRows = TRUE the tables are always sorted.
compareReports	Logical, if TRUE compare the report specifically (old method kept for robustness).
checkOutputFiles	Logical, if TRUE compare the file names of the output files.
tolerance	The tolerance to use in all.equal.
debug	Logical: If TRUE, interrupt the execution just before priting the test results.
save	Logical: If TRUE save the project before closing. Default (NULL) is to ask the user whether to save the project before closing.
...	Used in runModel().

StoXProject/RstoxFramework documentation built on Oct. 17, 2023, 1:24 p.m.