LoadMsiData: Load rMSI data from a compressed tar.
In prafols/rMSI: MSI Tools

Load rMSI data from a compressed tar.

LoadMsiData(
  data_file,
  restore_path = file.path(dirname(data_file), paste("ramdisk", basename(data_file),
    sep = "_")),
  fun_progress = NULL,
  ff_overwrite = F,
  fun_label = NULL,
  close_signal = NULL,
  imzMLChecksum = F,
  imzMLRename = NULL,
  imzMLSubCoords = NULL
)

`data_file`	The tar o imzML file containing the MS image in rMSI format or imzML.
`restore_path`	Where the ramdisk will be created.
`fun_progress`	This is a callback function to update the progress of loading data. See details for more information.
`ff_overwrite`	Tell ff to overwrite or not current ramdisk files.
`fun_label`	This is a callback function to update the progress bar dialog text.
`close_signal`	function to be called if the loading process is aborted.
`imzMLChecksum`	if the binary file checksum must be verified, it can be disabled for convenice with really big files.
`imzMLRename`	the image name, if NULL a default name based on the file name will be used.
`imzMLSubCoords`	a Complex vector with the motors coordinates to be included in the ramdisk, if NULL all positions will be used.

an rMSI object pointing to ramdisk stored data

Loads a rMSI data object from .tar compressed file or imzML format. It will be uncompressed at specified restore_path. fun_progress can be NULL or a function with the following prototipe: fun_progress( currentState ). If NULL is used a default command line progress bar is used. This function will be called periodically to monitor the loading status. This is usefull to implement progressbars. If ramdisk is already created befor calling this method the parameter ff_overwrite will control the loadin behaviour. If it is set to false (default) The ramdisk will be kept and the imaged loaded imediatelly. Otherwise if is set to true, the while dataset will be reloaded from tar file.

prafols/rMSI documentation built on Dec. 12, 2021, 7:29 p.m.