R/system-hooks.R

In NMproject: Script Based 'NONMEM' Model Development

#' Kill cluster job
#'
#' Can be useful in conjunction with a modified [system_nm()].  Requires setting `"kill_job"` option.
#'
#' @param m An nm object.
#'
#' @details The option `"kill_job"` needs to be defined as a function that kills
#'   a cluster job.
#'   
#' @return No return value, called for side effects.
#'
#' @seealso [system_nm()], [job_info()]
#'
#' @keywords internal
#' @export

kill_job <- function(m) {
  getOption("kill_job")(m)
}

#' Get job information (if it exists)
#'
#' Can be useful for storing job numbers with a modified [system_nm()].
#'
#' @param m An nm object.
#' @param text Optional character to set job_info.
#' 
#' @return The value of the `job_info` field of `m` if `text` is missing.
#'   Otherwise an nm object with modified `job_info` field.
#'
#' @seealso [system_nm()]
#'
#' @keywords internal
#' @export
job_info <- function(m, text) {
  UseMethod("job_info")
}

#' @export
job_info.nm_generic <- function(m, text) {
  if (missing(text)) custom_1d_field(m, "job_info") else custom_1d_field(m, "job_info", as.character(text))
}

#' @export
job_info.nm_list <- Vectorize_nm_list(job_info.nm_generic)