FTProcessHistory: Constructor for FTProcessHistory class

View source: R/Classes.R

FTProcessHistoryR Documentation

Constructor for FTProcessHistory class

Description

Construct a FTProcessHistory object with parameters for use with analyzeFT()

Usage

FTProcessHistory(
  error = list(),
  changes = TRUE,
  inputHash = NULL,
  outputHash = NULL,
  sessionInfo = NULL,
  fileNames = character(),
  processingTime = NA_real_,
  msLevel = NA_integer_,
  ...
)

Arguments

error

a named list of character() vectors, reporting errors that occured in this analysis step

changes

did changes occur on the associated object. If FALSE, this step did not result in relevant changes and could be dropped for reporting

inputHash

character MseekHash of the object before this analysis step

outputHash

character MseekHash of the object after this analysis step

sessionInfo

a sessionInfo object, should be generated at time of the recorded event and at least once in every session (by default, will be populated by load and constructor methods for MseekFT class).

fileNames

names of files used in this analysis step (a more human-readable variant of the fileIndex slot)

processingTime

time spent on processing this step, in seconds

msLevel, ...

additional arguments passed to XProcessHistory()

Details

FTProcessHistory

Value

a FTProcessHistory-class object

Examples

FTProcessHistory(error = list(),
changes = TRUE,
inputHash = NULL,
outputHash = NULL,
sessionInfo = utils::sessionInfo(),
info = "Example")


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