dot-withHistory: .withHistory

.withHistoryR Documentation



apply a function to an object and add this event to the object's processHistory, or return a list that contains the event history


  fun = character(),
  args = list(),
  longArgs = list(),
  addHistory = TRUE,
  continueWithErrors = FALSE,
  returnIfError = NULL



character(1), name of the function to apply


named list of arguments to fun, will be kept in the ProcessHistory as they are


arguments to fun that are large. They will be supplied to fun as they are, but will be summarized using summary() in the ProcessHistory.


if TRUE, adds the processing history to the output object if an addProcessHistory method exists for it. If FALSE, this function returns a list(), see Value!


if TRUE, if an error occurs during the call to fun, it is recorded in the ProcessHistory, and the value specified in returnIfError is returned.


object to return if error occurs. Will be treated like the object returned by fun (ProcessHistory will be added to the object if possible to keep track of failed analyses).


if addHistory = TRUE: the object returned by fun, with analyses performed as defined by args and longArgs and ProcessHistory added to the object. if addHistory = FALSE: a list with elements history and result

mjhelf/METABOseek documentation built on April 27, 2022, 5:13 p.m.