Difference between revisions of "Unit tests for QuiXoT"
(→Test 1: 18O quantification and statistical analysis from Proteome Discoverer results) |
m (→Test 1: 18O quantification and statistical analysis from Proteome Discoverer results) |
||
Line 4: | Line 4: | ||
1) Download the zip with the files from '''[[coming soon|here]]'''. | 1) Download the zip with the files from '''[[coming soon|here]]'''. | ||
+ | |||
2) After unzipping the files, you should have three folders: ''dir'', ''inv'', and ''raw''. | 2) After unzipping the files, you should have three folders: ''dir'', ''inv'', and ''raw''. | ||
::* The ''dir'' folder should contain an XML file called ''modifications.xml'' and and MSF file called ''110112_VSMC_EN_OG21.msf'' (the latter being an SQLite file containing identifications of the target SEQUEST search from Proteome Discoverer 1.4; the decoy search). | ::* The ''dir'' folder should contain an XML file called ''modifications.xml'' and and MSF file called ''110112_VSMC_EN_OG21.msf'' (the latter being an SQLite file containing identifications of the target SEQUEST search from Proteome Discoverer 1.4; the decoy search). | ||
::* The ''inv'' folder should contain an MSF file called ''110112_VSMC_EN_OG21-01.msf'' (an SQLite file containing the corresponding decoy SEQUEST search). | ::* The ''inv'' folder should contain an MSF file called ''110112_VSMC_EN_OG21-01.msf'' (an SQLite file containing the corresponding decoy SEQUEST search). | ||
::* The ''raw'' folder should contain a Thermo RAW file called ''110112_VSMC_EN_OG21.RAW'', containing all the spectral information saved by the spectrometre. | ::* The ''raw'' folder should contain a Thermo RAW file called ''110112_VSMC_EN_OG21.RAW'', containing all the spectral information saved by the spectrometre. | ||
+ | |||
3) After opening '''[[pRatio]]''', drag and drop the ''dir'' and ''inv'' folders in the ''Target search'' and ''Decoy search'' fields, respectively. Press the button ''Run!''. | 3) After opening '''[[pRatio]]''', drag and drop the ''dir'' and ''inv'' folders in the ''Target search'' and ''Decoy search'' fields, respectively. Press the button ''Run!''. | ||
+ | |||
4) After finishing, seven files should be saved in the ''dir'' folder, including four tab-separated text files (with XLS ending), and XML file (the '''[[QuiXML]]''' file), and two TXT files. | 4) After finishing, seven files should be saved in the ''dir'' folder, including four tab-separated text files (with XLS ending), and XML file (the '''[[QuiXML]]''' file), and two TXT files. | ||
+ | |||
5) Now we need to generate the '''[[binStack]]''' folder, extracting the information from all spectra. Using Thermo RAW files, you just need to open '''[[RAWToBinStack]]''', and then drag and drop three different files: | 5) Now we need to generate the '''[[binStack]]''' folder, extracting the information from all spectra. Using Thermo RAW files, you just need to open '''[[RAWToBinStack]]''', and then drag and drop three different files: | ||
:* The QuiXML generated in step #4 | :* The QuiXML generated in step #4 | ||
:* The QuiXML schema you are going to use to add the quantitative and statistical information. This is the XSD file within QuiXoT's conf folder, corresponding to the quantification method you are going to use. In this example, this is an 18O experiment using a high resolution mass spectrometre (Orbitrap), so you will need to drag and drop the file ''identifications_schema_18O_HR.xsd''. | :* The QuiXML schema you are going to use to add the quantitative and statistical information. This is the XSD file within QuiXoT's conf folder, corresponding to the quantification method you are going to use. In this example, this is an 18O experiment using a high resolution mass spectrometre (Orbitrap), so you will need to drag and drop the file ''identifications_schema_18O_HR.xsd''. | ||
:* The folder where the RAW files are. In this example, is the folder ''raw'', containing the file ''110112_VSMC_EN_OG21.RAW'' (note that you must drag and drop the folder, not just the file). | :* The folder where the RAW files are. In this example, is the folder ''raw'', containing the file ''110112_VSMC_EN_OG21.RAW'' (note that you must drag and drop the folder, not just the file). | ||
+ | |||
6) Fill the remaining information: | 6) Fill the remaining information: | ||
:* Spectrum type: the type of the spectrum where the quantitative information is. In the case of 18O this information is in the Full or ZoomScan; as this is a high resolution spectrometre, we should select the ''Full'' spectrum (ZoomScan is a type of scan used in low resolution machines). Note that for other techniques, such as iTRAQ, the quantitative information is in the MSMS spectra instead. | :* Spectrum type: the type of the spectrum where the quantitative information is. In the case of 18O this information is in the Full or ZoomScan; as this is a high resolution spectrometre, we should select the ''Full'' spectrum (ZoomScan is a type of scan used in low resolution machines). Note that for other techniques, such as iTRAQ, the quantitative information is in the MSMS spectra instead. | ||
Line 19: | Line 24: | ||
:* Usually, importing the whole spectrum leads to huge files difficult to manage, so, for 18O experiments, we recommend checking the option ''import only window around parental mz'' with 12 m/z (which should be enough to cover the 4 isotopologues of the non-labelled feature + 4 isotopologues of the labelled feature + 4 more m/z to get some context for possible artefacts). Other strategies such as iTRAQ would require checking ''import between these mzs'' (for iTRAQ 8plex, importing between 112 and 122 should be enough to cover the 113-121 range). | :* Usually, importing the whole spectrum leads to huge files difficult to manage, so, for 18O experiments, we recommend checking the option ''import only window around parental mz'' with 12 m/z (which should be enough to cover the 4 isotopologues of the non-labelled feature + 4 isotopologues of the labelled feature + 4 more m/z to get some context for possible artefacts). Other strategies such as iTRAQ would require checking ''import between these mzs'' (for iTRAQ 8plex, importing between 112 and 122 should be enough to cover the 113-121 range). | ||
:* In this example, we don't need advanced options, so we leave unchecked the ''average spectra'' feature. | :* In this example, we don't need advanced options, so we leave unchecked the ''average spectra'' feature. | ||
+ | |||
7) Press ''create binStack''. For this small example, the generation of the binStack should be fast (few seconds), but for normal or large experiments this might take between few minutes to some hours, depending on the experiment. | 7) Press ''create binStack''. For this small example, the generation of the binStack should be fast (few seconds), but for normal or large experiments this might take between few minutes to some hours, depending on the experiment. | ||
Revision as of 14:39, 24 April 2017
We present here four experiments you may use to check QuiXoT, as well as testing it is working as expected in your machine:
Contents
- 1 Test 1: 18O quantification and statistical analysis from Proteome Discoverer results
- 2 Test 2: 18O quantification statistical analysis starting from QuiXML file + binStack
- 3 Test 3: iTRAQ statistical analysis starting from QuiXML file + binStack
- 4 Test 4: SILAC statistical analysis starting from QuiXML file + binStack
Test 1: 18O quantification and statistical analysis from Proteome Discoverer results
1) Download the zip with the files from here.
2) After unzipping the files, you should have three folders: dir, inv, and raw.
- The dir folder should contain an XML file called modifications.xml and and MSF file called 110112_VSMC_EN_OG21.msf (the latter being an SQLite file containing identifications of the target SEQUEST search from Proteome Discoverer 1.4; the decoy search).
- The inv folder should contain an MSF file called 110112_VSMC_EN_OG21-01.msf (an SQLite file containing the corresponding decoy SEQUEST search).
- The raw folder should contain a Thermo RAW file called 110112_VSMC_EN_OG21.RAW, containing all the spectral information saved by the spectrometre.
3) After opening pRatio, drag and drop the dir and inv folders in the Target search and Decoy search fields, respectively. Press the button Run!.
4) After finishing, seven files should be saved in the dir folder, including four tab-separated text files (with XLS ending), and XML file (the QuiXML file), and two TXT files.
5) Now we need to generate the binStack folder, extracting the information from all spectra. Using Thermo RAW files, you just need to open RAWToBinStack, and then drag and drop three different files:
- The QuiXML generated in step #4
- The QuiXML schema you are going to use to add the quantitative and statistical information. This is the XSD file within QuiXoT's conf folder, corresponding to the quantification method you are going to use. In this example, this is an 18O experiment using a high resolution mass spectrometre (Orbitrap), so you will need to drag and drop the file identifications_schema_18O_HR.xsd.
- The folder where the RAW files are. In this example, is the folder raw, containing the file 110112_VSMC_EN_OG21.RAW (note that you must drag and drop the folder, not just the file).
6) Fill the remaining information:
- Spectrum type: the type of the spectrum where the quantitative information is. In the case of 18O this information is in the Full or ZoomScan; as this is a high resolution spectrometre, we should select the Full spectrum (ZoomScan is a type of scan used in low resolution machines). Note that for other techniques, such as iTRAQ, the quantitative information is in the MSMS spectra instead.
- The position of the spectra containing quantitative information, relative to the spectra used to identify the peptide. For 18O experiments, this should be set to previous, as for these strategies the quantitative information is in the first Full scan prior to the identification (first a Full scan is taken, and then each of the most intense peaks are selected for fragmentation and identification). Note that other strategies, such as iTRAQ, are quantified in the same spectrum where peptides are identified.
- Usually, importing the whole spectrum leads to huge files difficult to manage, so, for 18O experiments, we recommend checking the option import only window around parental mz with 12 m/z (which should be enough to cover the 4 isotopologues of the non-labelled feature + 4 isotopologues of the labelled feature + 4 more m/z to get some context for possible artefacts). Other strategies such as iTRAQ would require checking import between these mzs (for iTRAQ 8plex, importing between 112 and 122 should be enough to cover the 113-121 range).
- In this example, we don't need advanced options, so we leave unchecked the average spectra feature.
7) Press create binStack. For this small example, the generation of the binStack should be fast (few seconds), but for normal or large experiments this might take between few minutes to some hours, depending on the experiment.
8) The output of the RAWToBinStack is:
- A binStack folder should appear, containing several BFR files and one index.idx file. As they are binary files, so they are not usable with text editors.
- A *_QuiXML_bs.xml file, which is the same as the input QuiXML file, but containing indexation of spectra (it is written with a new name, instead of being overwritten, in order to prevent information loss in case the previous steps go wrong).
9) Now we can open this output file with QuiXoT: execute QuiXoT.exe, and then drag and drop the *_QuiXML_bs.xml file. Choose the strategy (for this example, 18O, HR, SEQUEST).
Test 2: 18O quantification statistical analysis starting from QuiXML file + binStack
In the following examples, we start with QuiXML/binStack files, so we can skip some of the initial steps.
- Download the zip with the files from here.
...
Test 3: iTRAQ statistical analysis starting from QuiXML file + binStack
- Download the zip with the files from here.
...
Test 4: SILAC statistical analysis starting from QuiXML file + binStack
- Download the zip with the files from here.
...