Perform Sanity Checks On Input Excel File

Do a set of sanity checks on the input Excel file.

CheckInputExcelFileFormat(
  inputFile = NULL,
  outputFile = NULL,
  scenarioSheet = "Scenarios",
  seasonalityOffsetsSheet = "SeasonalityOffsets",
  noDate = FALSE
)

Arguments

inputFile

Excel file to examine. If NULL, check the file defined in the global Configuration.

outputFile

Results output file. If NULL, results are printed to the console.

scenarioSheet

Name of the sheet with scenario details. Default = "Scenarios".

seasonalityOffsetsSheet

Name of the sheet with per-task seasonality offset details. Default = "SeasonalityOffsets"

noDate

Suppress date stamp from output. Default = FALSE.

Value

Error code. 0 = Success < 0 (negative) = Fatal error. Nothing will work right. > 0 (positive) = Warning. Some scenarios might fail, some might succeed.

Examples

if (FALSE) {
errCode <- pacehrh::CheckInputExcelFileFormat(outputFile = "config_file_check.txt")
}