BodenmillerGroup / imcRtools

An R package for handling and analysing imaging mass cytometry data
https://bodenmillergroup.github.io/imcRtools/
20 stars 10 forks source link

Read steinbock metadata from images.csv #38

Closed jwindhager closed 3 years ago

jwindhager commented 3 years ago

With steinbock v0.8.0, as requested by @SchulzDan, image metadata is written to images.csv upon preprocessing. As discussed offline, this metadata should be made available to the imcRtools user through the SingleCellExperiment (please discuss with @SchulzDan what information is relevant).

Please note that the existence of an images.csv file is optional (the user may choose to not use steinbock for preprocessing and to instead directly start from TIFF files) and that the filename can be modified by the user. If such a file is present, it can be expected to adhere to the steinbock "image information" file specifications.

Additional columns that are added specifically when preprocessing IMC data (currently undocumented):

The test data in https://github.com/BodenmillerGroup/TestData has been updated.

nilseling commented 3 years ago

Hey @jwindhager, is the images.csv file written out by default? I mean in case the user pre-processes images using steinbock.

jwindhager commented 3 years ago

Yes it is, if the user uses Steinbock IMC preprocessing functionality (specifically, steinbock preprocess imc images)

nilseling commented 3 years ago

Aight! What about other multi-channel images? From the docs it looks like it's always written out with the columns you documented

nilseling commented 3 years ago

Done in 6299fec84e4be05e7cd7c67abc654ca6f222acad

jwindhager commented 3 years ago

Aight! What about other multi-channel images? From the docs it looks like it's always written out with the columns you documented

Currently, preprocessing functionality is provided for IMC only