add checks to existingModel

R/ExistingPython.R

@@ -24,7 +24,7 @@
 #' This function lets users add an existing scikit learn that is saved as model.pkl
 #' into PLP format.  covariateMap is a mapping between standard covariateIds and the model column names
 #' and order are required in addition to pythonModelLocation, the location of the model that must be saved
-#' as model.pkl .  The user also needs to specify the covariate settings and population settings as these
+#' as `model.pkl`.  The user also needs to specify the covariate settings and population settings as these
 #' are used to determine the standard PLP model design.
 #'
 #' @param pythonModelLocation  The location of the folder that contains the model as model.pkl
@@ -56,6 +56,11 @@ createSciKitLearnModel <- function(
     populationSettings, # specify time at risk used to develop model
     isPickle = TRUE) {
   checkSklearn() 
+  checkFileExists(pythonModelLocation)
+  checkIsClass(covariateMap, "data.frame")
+  checkIsClass(covariateSettings, "covariateSettings")
+  checkIsClass(populationSettings, "populationSettings")
+  checkBoolean(isPickle)
   existingModel <- list(model = "existingPython")
   class(existingModel) <- "modelSettings"
 

R/Logging.R

@@ -62,7 +62,7 @@ createLog <- function(
     logName = "PLP Log",
     saveDirectory = getwd(),
     logFileName = paste0("plpLog", as.Date(Sys.Date(), "%Y%m%d"), ".txt")) {
-  checkFileExists(saveDirectory, createIfNot = TRUE)
+  checkDirExists(saveDirectory, createIfNot = TRUE)
 
   logFileName <- gsub("[[:punct:]]", "", logFileName)
 
@@ -83,17 +83,6 @@ createLog <- function(
   return(logger)
 }
 
-checkFileExists <- function(
-    saveDirectory,
-    createIfNot = TRUE) {
-  dirExists <- dir.exists(saveDirectory)
-  if (!dirExists && createIfNot) {
-    ParallelLogger::logInfo(paste0("Creating save directory at: ", saveDirectory))
-    dir.create(saveDirectory, recursive = TRUE)
-  }
-  return(invisible(dirExists))
-}
-
 closeLog <- function(logger) {
   # stop logger
   ParallelLogger::unregisterLogger(logger)

R/ParamChecks.R

@@ -118,3 +118,22 @@ checkFileType <- function(parameter, fileType) {
   return(TRUE)
 }
 
+checkDirExists <- function(
+    saveDirectory,
+    createIfNot = TRUE) {
+  dirExists <- dir.exists(saveDirectory)
+  if (!dirExists && createIfNot) {
+    ParallelLogger::logInfo(paste0("Creating save directory at: ", saveDirectory))
+    dir.create(saveDirectory, recursive = TRUE)
+  }
+  return(invisible(dirExists))
+}
+
+checkFileExists <- function(parameter) {
+  name <- deparse(substitute(parameter))
+  if (!file.exists(parameter)) {
+    ParallelLogger::logError(paste0(name, " does not exist"))
+    stop(paste0(name, " does not exist"))
+  }
+  return(TRUE)
+}