Return the optimization state to the user on successful finish. (#362)

* Return the optimization state to the user on successful finish.
Give the user the option to continue a finished optimization run.
This enables the user to handle the saving of backup states himself.

* Apparently roxygenise doesnt happen automatically during build.

* name save.state, final opt.state

Author: mb706

R/MBOResult.R

@@ -49,6 +49,7 @@ makeMBOResult.OptState = function(opt.state) {
       resample.results = getOptResultResampleResults(opt.result),
       final.state = getOptStateState(opt.state),
       models = getOptResultStoredModels(opt.result),
+      final.opt.state = opt.state,
       control = control
     )
   } else {
@@ -59,6 +60,7 @@ makeMBOResult.OptState = function(opt.state) {
       opt.path = getOptStateOptPath(opt.state),
       final.state = getOptStateState(opt.state),
       models = getOptResultStoredModels(opt.result),
+      final.opt.state = opt.state,
       control = control
     )
   }

R/mboContinue.R

@@ -4,14 +4,18 @@
 #' Useful if your optimization is likely to crash,
 #' so you can continue from a save point and will not lose too much information and runtime.
 #'
-#' @param file [\code{character(1)}]\cr
-#'   File path of saved MBO state.
+#' @param opt.state [\code{OptState} | \code{character(1)}]\cr
+#'   Either the \code{save.state} slot of an \code{MBOResult} object, or a file path of a saved MBO state.
 #'   See \code{save.on.disk.at} argument of \code{\link{MBOControl}} object.
 #' @return See \code{\link{mbo}}.
 #' @export
-mboContinue = function(file) {
-  assertCharacter(file, len = 1L)
-  opt.state = loadOptState(file)
+mboContinue = function(opt.state) {
+  if (checkCharacter(opt.state, len = 1L)) {
+    opt.state = loadOptState(opt.state)
+  }
+  if (!inherits(opt.state, "OptState")) {
+    stop("opt.state must be either an OptState object, or a file path of a saved OptState.")
+  }
   state = getOptStateState(opt.state)
   if (state %nin% c("init", "iter")) {
     warningf("Tuning ended with %s. No need to continue. Simply returning stored result.", state)