rename_leica: Leica renamer

In hmbotelho/htmrenamer: File Renaming Tools for High Throughput Microscopy

Leica renamer

Description

Renaming of Leica files according to a microscope infile. Auto-detects the software which generated the images to call the apropriate renamer function. See newinfile.df or newinfile.char for a description of the infile structure.

Usage

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

Arguments

sourcefolder	character, the folder with raw images.
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

None, this function just calls another function to perform the renaming.

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.