rename_leica_matrixscreener: Leica renamer (MatrixScreener)

View source: R/leica.r

rename_leica_matrixscreenerR Documentation

Leica renamer (MatrixScreener)

Description

Renaming of Leica MatrixScreener files according to a microscope infile. See newinfile.df or newinfile.char for a description of the infile structure.

Usage

rename_leica_matrixscreener(
  sourcefolder,
  targetfolder,
  infilepath,
  compress = FALSE,
  move = FALSE,
  outputDescriptors = TRUE,
  printMessages = TRUE,
  printFiles = TRUE,
  printToGUI = FALSE
)

Arguments

sourcefolder

character, the folder with raw images. The folder usually has the folllowing name structure: demoplate_01--2019_01_01_12_00_00

targetfolder

character, folder where to place renamed files. A subfolder wih the same name as the infile will be created by the function and must not exist previously.

infilepath

character, location of the microscope infile

compress

logical, compress raw images?

move

logical, move (rather than copy) raw images?

outputDescriptors

logical, save plain text files with experimental metadata?

printMessages

logical, print messages in the console?

printFiles

logical, print file-by-file progress in the console?

printToGUI

logical, print messages to the renamer GUI?

Value

Renamed files, metadata and log file

See Also

rename_leica_gui for interacting with this function using a GUI.


hmbotelho/htmrenamer documentation built on April 11, 2025, 11:04 p.m.