kevinkovalchik / RawTools

RawTools is an open-source and freely available package designed to perform scan data parsing and quantification, and quality control analysis of Thermo Orbitrap raw mass spectrometer files from data-dependent acquisition experiments.
Apache License 2.0
64 stars 19 forks source link

What is QC standing for? #24

Closed sorenwacker closed 5 years ago

sorenwacker commented 5 years ago

RawTools has the option qc.

Perform QC operations. Two arguments are required: -d, the directory containing one or more raw files to QC; -q, a directory in which to hold the QC data. -q and -d can be identical if desired. After running for the first time on a given directory, a file called QC.xml will appear in the QC directory. It is an xml file containing the QC data. If new files are copied or acquired into the -d directory, QC may be run again and the new files will be added to the QC data.

Does it stand for quality control?

kevinkovalchik commented 5 years ago

Yes, it stands for quality control. I see the help is missing some information. An XML file is generated, but that is mostly for storing the data for application use. A CSV file is also created which contains the data in a more accessible format. The idea is you will use it with a series of files, most likely all the files from a run or a multi-run experiment. You can then visualize the performance metrics generated for all the files to see if and how these metrics are changing with time. We have an online app for viewing this data (https://rawtoolsqcdv.bcgsc.ca/), or it can easily be viewed in R, python, or excel.

sorenwacker commented 5 years ago

That is very nice! What happens if the files I want to monitor are not all in the same directory? Can I pass multiple directories or would I pass one by one and add to the xml file?

kevinkovalchik commented 5 years ago

You would need to pass the directories one by one. But you can keep referencing the same QC data directory (the -q argument), so the data will get added to the single xml and csv files.