Skip to content

Commit

Permalink
Update DIA tutorial.
Browse files Browse the repository at this point in the history
  • Loading branch information
fcyu committed Dec 21, 2023
1 parent 5e2443c commit a93a810
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
Binary file added docs/Tutorial-5-DIA-Fragpipe.pdf
Binary file not shown.
22 changes: 11 additions & 11 deletions docs/tutorial_DIA.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,33 @@ FragPipe currently offers two workflows for DIA data:

2) [**DIA_DIA-Umpire_SpecLib_Quant**](https://fragpipe.nesvilab.org/docs/tutorial_DIA.html#dia_dia-umpire_speclib_quant) - takes DIA data (plus optional DDA data) as input, DIA-Umpire generates pseudo-MS/MS spectra from the DIA files (instead of direct search with MSFragger-DIA), then MSFragger in DDA mode is used to search, followed by quantification with DIA-NN

**Recommendation: do not assign the files to any experimental groups. FragPipe builds a single spectral library using all files.**

If more than one experimental group are created, FragPipe will generate a spectral library for each group, and use it for the DIA runs in the same group. Spectral libraries from different groups will not be used together.

Please note:

* DIA data acquired with overlapping/staggered windows must be converted to mzML using the 'Demultiplex' filter, see [this page](https://fragpipe.nesvilab.org/docs/tutorial_convert.html#convert-thermo-dia-raw-files-with-overlappingstaggered-windows).
* To quantify from .raw files, Thermo MS File Reader must be installed, see the [DIA-NN documentation](https://github.com/vdemichev/DiaNN#raw-data-formats) for details.
* Any pseudo-MS/MS files from DIA-Umpire (`*_Q1.mzML`, `*_Q2.mzML`, `*_Q3.mzML`) should be designated DDA data type on the Workflow tab.
* If you already have a spectral library and want to quantify only, uncheck all steps except 'Quantify with DIA-NN' on the 'Quant (DIA)' tab, set the path to the spectral library, and run.
* Multiple spectral libraries can be generated in a single FragPipe run if multiple experiments are specified on the Workflow tab. In each experiment, FragPipe uses the spectral library for the DIA runs in the same experiment. Spectral libraries from different experiments will not be used together.
* If iRT peptides were spiked-in to the samples, change the 'RT calibration' option on the 'Spec Lib' tab to 'iRT'. EasyPQP will use the [ciRT](https://www.mcponline.org/article/S1535-9476(20)32633-5/fulltext) option by default.
* diaPASEF data is not supported at this time.
* Skyline users may also choose to import interact-.pep.xml files into Skyline for spectral library building and further analysis of DIA experiments, see this [tutorial](https://fragpipe.nesvilab.org/docs/tutorial_skyline.html).

<br>

### Configure FragPipe
Python (with EasyPQP installed) is needed for spectral library generation. On the Config tab, check that a valid Python path is provided (Python version will be shown) and that EasyPQP is 'Available'. If Python is installed but EasyPQP is missing, click the 'Install/Upgrade EasyPQP' button and wait a minute or so for installation. For help installing Python, see [this page](https://fragpipe.nesvilab.org/docs/tutorial_setup_fragpipe.html#optional-install-update-or-use-an-already-installed-version-of-python).

![](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/images/DIA-tutorial_setup.png)
<br>


### DIA_SpecLib_Quant
1. In the Workflow tab, select the 'DIA_SpecLib_Quant' workflow from the dropdown menu and click 'Load'.
2. Load DIA (and optionally additional DDA) spectral files in mzML or raw format. You can use the 'Add folder recursively' button to browse for the unzipped 'speclib-raw' folder, which will load 2 DIA files and 2 DDA files. The data type of each file will be automatically **guessed** by FragPipe. The guess is based on the folder and file name. **Please double check the data type and adjust it if necessary.**
2. Load DIA (and optionally additional DDA) spectral files in mzML or raw format. The data type of each file will be automatically **guessed** by FragPipe. The guess is based on the folder and file name. **Please double check the data type and adjust it if necessary.**

![](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/images/DIA-tutorial_SpecLib_Quant_workflow.png)
![](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/images/DIA-tutorial_SpecLib_Quant_workflow.jpg)


3. On the Database tab, use 'Browse' to select the FASTA sequence database file `2021-05-13-decoys-UPS-reviewed-contam-UP000000589.fas` in the 'speclib-raw' folder. This is a mouse database with reviewed sequences, decoys, common contaminants, and iRT peptides. UPS protein sequences have been manually added.
3. On the Database tab, use 'Browse' to select the FASTA sequence database file.

![](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/images/DIA-tutorial_database.png)
![](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/images/DIA-tutorial_database.jpg)


4. On the 'Quant (DIA)' tab, note that DIA-NN will be run unless unchecked. The spectral library generated by FragPipe will automatically be passed to DIA-NN for quantification of the DIA files provided.
Expand All @@ -65,6 +58,13 @@ Follow the same steps as above to run the 'DIA_DIA-Umpire_SpecLib_Quant' workflo

![](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/images/share-diaumpire.png)


### A more comprehensive tutorial from the [EMBO Practical Course: Targeted proteomics](https://meetings.embo.org/event/23-targeted-proteomics)

The tutorial file can be found from [here](https://raw.githubusercontent.com/Nesvilab/FragPipe/gh-pages/docs/Tutorial-5-DIA-Fragpipe.pdf).

The mzML ans FASTA files can be downloaded from [here](https://www.dropbox.com/scl/fo/zpd2rxlh6uzg0ewyhqtir/h?rlkey=25fgtzhckw9q8adu12kd7mjnp&dl=1).

<br>
<br>

Expand Down
Binary file added images/DIA-tutorial_SpecLib_Quant_workflow.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/DIA-tutorial_SpecLib_Quant_workflow.png
Binary file not shown.
Binary file added images/DIA-tutorial_database.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/DIA-tutorial_database.png
Binary file not shown.
Binary file modified images/share-diann.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/share-diaumpire.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a93a810

Please sign in to comment.