TPP Tutorial v2
From SPCTools
Revision as of 19:39, 26 May 2011 Luis (Talk | contribs) (→2. Download and install the test data and database) ← Previous diff |
Current revision JoeS (Talk | contribs) |
||
Line 1: | Line 1: | ||
+ | <span style="color:red">Special Note: There is a newer (and somewhat simpler) tutorial that you may want to follow, at [[TPP_Tutorial]].</span> | ||
+ | |||
= Quick Start to data analysis using the TPP = | = Quick Start to data analysis using the TPP = | ||
== 1. Download and install the TPP == | == 1. Download and install the TPP == | ||
- | To install on your Windows system, please follow our [[Windows Installation Guide]], making sure that you select to download the file "TPP_Setup_v4_4_VUVUZELA_rev_1.exe" from our [http://sourceforge.net/projects/sashimi/files/ Sourceforge download site]. | + | To install on your Windows system, please follow our [[Windows Installation Guide]], making sure that you select to download the the latest version of TPP from our [http://sourceforge.net/projects/sashimi/files/ Sourceforge download site]. |
=== Log into Petunia, the TPP GUI === | === Log into Petunia, the TPP GUI === | ||
Line 15: | Line 17: | ||
For this demo, we will be using a SILAC-labeled Yeast dataset, comprised of 2 runs on a high mass-accuracy Orbitrap instrument, along with a Yeast database appended with decoys. We also include a search parameters file. | For this demo, we will be using a SILAC-labeled Yeast dataset, comprised of 2 runs on a high mass-accuracy Orbitrap instrument, along with a Yeast database appended with decoys. We also include a search parameters file. | ||
- | * If you would like to start the pipeline with the conversion of the vendor's raw data format to the open ''mzML'' format, you will need to install the free [http://www.microsoft.com/downloads/details.aspx?familyid=A5C84275-3B97-4AB7-A40D-3802B2AF5FC2&displaylang=en Microsoft Visual C++ 2008 SP1 Redistributable Package], [http://www.microsoft.com/downloads/details.aspx?FamilyID=ab99342f-5d1a-413d-8319-81da479ab0d7&displaylang=en Microsoft .NET Framework 3.5 SP1], as well as the free [http://sjsupport.thermofinnigan.com/public/detail.asp?id=586 MSFileReader from Thermo]. You can then [ftp://ftp:a@ftp.peptideatlas.org/pub/PeptideAtlas/Repository/TPP_Demo2009/TPP_Demo2009_RAW_data.zip download the raw demo data as a zip file] (308Mb) and unzip (you can obtain a free unzip utility, such as 7zip, from the web). You should find 2 files. | + | * If you would like to start the pipeline with the conversion of the vendor's raw data format to the open ''mzML'' format, you will need to install the free [http://sjsupport.thermofinnigan.com/public/detail.asp?id=703 Thermo MS File Reader]. You can then [ftp://ftp:a@ftp.peptideatlas.org/pub/PeptideAtlas/Repository/TPP_Demo2009/TPP_Demo2009_RAW_data.zip download the raw demo data as a zip file] (309Mb) and unzip (you can obtain a free unzip utility, such as 7zip, from the web). You should find 2 files. |
- | * If you would rather skip this conversion step, please [ftp://ftp:a@ftp.peptideatlas.org/pub/PeptideAtlas/Repository/TPP_Demo2009/TPP_Demo2009_mzML_data.zip download the pre-converted mzML files] (766Mb) and unzip. | + | * If you would rather skip this conversion step, please [ftp://ftp:a@ftp.peptideatlas.org/pub/PeptideAtlas/Repository/TPP_Demo2009/TPP_Demo2009_mzML_data.zip download the pre-converted mzML files] (768Mb) and unzip. |
- | * Lastly, [ftp://ftp:a@ftp.peptideatlas.org/pub/PeptideAtlas/Repository/TPP_Demo2009/TPP_Demo2009_db_and_tandemParams.zip download the parameters and database files] (4.4Mb) and unzip. | + | * Lastly, [ftp://ftp:a@ftp.peptideatlas.org/pub/PeptideAtlas/Repository/TPP_Demo2009/TPP_Demo2009_db_and_tandemParams.zip download the parameters and database files] (2.1Mb) and unzip. |
* Copy or move the ''yeast_orfs_all_REV.20060126.short.fasta'' file into the folder ''C:\Inetpub\wwwroot\ISB\data\dbase'' | * Copy or move the ''yeast_orfs_all_REV.20060126.short.fasta'' file into the folder ''C:\Inetpub\wwwroot\ISB\data\dbase'' | ||
* Copy or move the two data files (''OR20080317_S_SILAC-LH_1-1_01.raw'' and ''OR20080317_S_SILAC-LH_1-1_11.raw'') -- or the .mzML files if that is what you downloaded -- as well as the tandem parameters file ''tandem.xml'' into the folder ''C:\Inetpub\wwwroot\ISB\data\demo2009\tandem'' . Create this last folder if necessary. | * Copy or move the two data files (''OR20080317_S_SILAC-LH_1-1_01.raw'' and ''OR20080317_S_SILAC-LH_1-1_11.raw'') -- or the .mzML files if that is what you downloaded -- as well as the tandem parameters file ''tandem.xml'' into the folder ''C:\Inetpub\wwwroot\ISB\data\demo2009\tandem'' . Create this last folder if necessary. | ||
+ | |||
+ | ''Please note that this tutorial assumes that you are running a default TPP installation on a Windows system; if you are using a different system, please adjust the parameters files and file locations accordingly.'' | ||
== 3. Convert raw data to the mzML format == | == 3. Convert raw data to the mzML format == | ||
Line 31: | Line 35: | ||
* Mouse-over the '''Analysis Pipeline (Tandem)''' portion of the navigation links near the top of the Petunia page; a pop-up menu should appear. Select the '''mzML''' item in this menu. | * Mouse-over the '''Analysis Pipeline (Tandem)''' portion of the navigation links near the top of the Petunia page; a pop-up menu should appear. Select the '''mzML''' item in this menu. | ||
+ | * Make sure the option '''Thermo RAW''' is selected as the instrument type you want to convert | ||
* Click on the '''Add Files''' button in the first section; the File Chooser window will open. | * Click on the '''Add Files''' button in the first section; the File Chooser window will open. | ||
* Click on the '''demo2009''' directory link on the right portion of the page. Then select '''tandem'''. | * Click on the '''demo2009''' directory link on the right portion of the page. Then select '''tandem'''. | ||
* Select both raw data files by clicking on the checkbox next to each, then on the '''Select''' button at the bottom. This should return you to the mzML page along with a confirmation of the files that you just selected. | * Select both raw data files by clicking on the checkbox next to each, then on the '''Select''' button at the bottom. This should return you to the mzML page along with a confirmation of the files that you just selected. | ||
* Leave the ''Conversion Options'' unchecked. | * Leave the ''Conversion Options'' unchecked. | ||
- | * Click on '''Convert to mzML'''; a wait page should appear. It takes about 30mins to convert two files. | + | * Click on '''Convert to mzML'''; a wait page should appear. It takes up to 30mins to convert two files; maybe only 5min if you have a fast new machine. |
* The ''Command Status'' box should automatically change color to orange when the conversions are done. | * The ''Command Status'' box should automatically change color to orange when the conversions are done. | ||
Line 118: | Line 123: | ||
* Click on the '''Analyze Peptides''' tab under the ''Analysis Pipeline'' section in ''Petunia'' to access the ''xinteract'' interface again. | * Click on the '''Analyze Peptides''' tab under the ''Analysis Pipeline'' section in ''Petunia'' to access the ''xinteract'' interface again. | ||
* Select the '''interact.iproph.pep.xml''' file in the directory '''demo2009'''. Make sure that there is only one file selected for analysis; you can edit the selections using the checkboxes and ''Remove'' button on the right-hand side. | * Select the '''interact.iproph.pep.xml''' file in the directory '''demo2009'''. Make sure that there is only one file selected for analysis; you can edit the selections using the checkboxes and ''Remove'' button on the right-hand side. | ||
- | * '''Important''': Make sure that you '''uncheck''' the option to ''RUN PeptideProphet'' under ''PeptideProphet Options'', as this file already contains results from PeptideProphet. | + | |
- | * Under ''ASAPRatio Options'', select to '''RUN ASAPRatio''', change ''Labeled Residues'' to '''K''' and '''R''', set ''m/z range to include in summation of peak'' to '''0.05''', set ''Specified masses'' to '''M 147.035, K 136.10916,''' and '''R 166.10941'''. | + | ;'''Important''' |
+ | : Change ''"Write output to file:"'' to have the same name as the input file '''interact.iproph.pep.xml''', | ||
+ | |||
+ | |||
+ | ; Under '''PeptideProphet Options''' | ||
+ | : Make sure that you '''uncheck''' the option to ''RUN PeptideProphet'' under ''PeptideProphet Options'', | ||
+ | : Under ''"Enter additional options to pass directly to the command-line (expert use only!)"'', copy the text: <code>-nI</code> | ||
+ | |||
+ | ; Under '''ASAPRatio Options''' | ||
+ | :select to '''RUN ASAPRatio''', change ''Labeled Residues'' to '''K''' and '''R''' | ||
+ | :set ''m/z range to include in summation of peak'' to '''0.05''' | ||
+ | :set ''Specified masses'' to '''M 147.035, K 136.10916,''' and '''R 166.10941'''. | ||
* Leave all other options set to their defaults, and click on '''Run XInteract''' at the bottom of the page to run ''ASAPRatio''. | * Leave all other options set to their defaults, and click on '''Run XInteract''' at the bottom of the page to run ''ASAPRatio''. | ||
Line 133: | Line 149: | ||
* once the command finishes running, you can click on the view results link that appears in the Command Status box to view and analyze the results. Protein groups are sorted in descending order by Probability so that the groups at the top of the page are the most confident identifications. The protein probabilities are the red numbers listed next to each protein group. [http://tools.proteomecenter.org/wiki/index.php?title=Image:Protxml.JPG IMG:Protxml] | * once the command finishes running, you can click on the view results link that appears in the Command Status box to view and analyze the results. Protein groups are sorted in descending order by Probability so that the groups at the top of the page are the most confident identifications. The protein probabilities are the red numbers listed next to each protein group. [http://tools.proteomecenter.org/wiki/index.php?title=Image:Protxml.JPG IMG:Protxml] | ||
- | |||
- | = Other Resources = | ||
- | * You can find a longer, more thorough tutorial at the [[TPP Tutorial]] page of our Wiki. |
Current revision
Special Note: There is a newer (and somewhat simpler) tutorial that you may want to follow, at TPP_Tutorial.
Quick Start to data analysis using the TPP
1. Download and install the TPP
To install on your Windows system, please follow our Windows Installation Guide, making sure that you select to download the the latest version of TPP from our Sourceforge download site.
Log into Petunia, the TPP GUI
As a way to verify that the installation was successful, log into Petunia by double-clicking on the Trans-Proteomic Pipeline flower icon on your Desktop or through the Start menu. Alternatively, you can open a browser window into the following URL: http://localhost/tpp-bin/tpp_gui.pl . You can use the credentials guest and guest as user name and password to log in.
Once you are in the Home page, please select Tandem as the analysis pipeline, just below the Welcome message.
2. Download and install the test data and database
For this demo, we will be using a SILAC-labeled Yeast dataset, comprised of 2 runs on a high mass-accuracy Orbitrap instrument, along with a Yeast database appended with decoys. We also include a search parameters file.
- If you would like to start the pipeline with the conversion of the vendor's raw data format to the open mzML format, you will need to install the free Thermo MS File Reader. You can then download the raw demo data as a zip file (309Mb) and unzip (you can obtain a free unzip utility, such as 7zip, from the web). You should find 2 files.
- If you would rather skip this conversion step, please download the pre-converted mzML files (768Mb) and unzip.
- Lastly, download the parameters and database files (2.1Mb) and unzip.
- Copy or move the yeast_orfs_all_REV.20060126.short.fasta file into the folder C:\Inetpub\wwwroot\ISB\data\dbase
- Copy or move the two data files (OR20080317_S_SILAC-LH_1-1_01.raw and OR20080317_S_SILAC-LH_1-1_11.raw) -- or the .mzML files if that is what you downloaded -- as well as the tandem parameters file tandem.xml into the folder C:\Inetpub\wwwroot\ISB\data\demo2009\tandem . Create this last folder if necessary.
Please note that this tutorial assumes that you are running a default TPP installation on a Windows system; if you are using a different system, please adjust the parameters files and file locations accordingly.
3. Convert raw data to the mzML format
We have developed the TPP (and dozens of related tools) to read mass-spec data from a common, open data format. We must therefore first convert the proprietary raw data to this format, called mzML.
- If you downloaded the mzML files directly in step 2, skip to step 4.
- Mouse-over the Analysis Pipeline (Tandem) portion of the navigation links near the top of the Petunia page; a pop-up menu should appear. Select the mzML item in this menu.
- Make sure the option Thermo RAW is selected as the instrument type you want to convert
- Click on the Add Files button in the first section; the File Chooser window will open.
- Click on the demo2009 directory link on the right portion of the page. Then select tandem.
- Select both raw data files by clicking on the checkbox next to each, then on the Select button at the bottom. This should return you to the mzML page along with a confirmation of the files that you just selected.
- Leave the Conversion Options unchecked.
- Click on Convert to mzML; a wait page should appear. It takes up to 30mins to convert two files; maybe only 5min if you have a fast new machine.
- The Command Status box should automatically change color to orange when the conversions are done.
4. Search data with X!Tandem
A custom version of the popular open-source search engine X!Tandem is bundled and installed with the TPP. It has been modified from the original distribution by adding the K-Score scoring function, developed by a team at the Fred Hutchinson Cancer Research Center.
- First, make sure that Tandem is selected as the analysis pipeline.
- Click the Database Search tab under Analysis Pipeline to access the X!Tandem search interface.
- Under Specify mzXML Input Files, click Add Files and select the two mzML files present in the demo2009\tandem directory as input files for database searching.
- Similarly, under Specify Tandem Parameters File choose the Tandem parameters file called tandem.xml located in the same directory.
- This file defines the database search parameters that override the full set of default settings referenced in the file isb_default_input.
- In this example, the mass tolerance is set to -2.1 Da to 4.1 Da, and the residue modification mass is set to 57.021464@C. A wide mass tolerance is used to include all the spectra with precursor m/z off by one or more isotopic separations; the high accuracy achieved by the instrument is then modeled by PeptideProphet with the accurate mass model.
- For more information, please go to TANDEM
- Lastly, select a sequence database to search against. Navigate up to the dbase directory in the File Chooser, and select the database file yeast_orfs_all_REV.20060126.short.fasta.
- Start the search by clicking on Run Tandem Search. The search needs about 25mins for two files.
Convert results to PepXML
Since each search engine provides results in different ways, the TPP requires that they be converted to a common format for downstream processing. This is the PepXML format, and can the conversion can be effected via the pepXML tab of the Analysis Pipeline.
- Choose the two OR2008*.tandem files in the demo2009\tandem directory; these are the X!Tandem search results.
- Click on Convert to PepXML.
5. Search data with SpectraST
SpectraST is a search engine that compares acquired spectra against a library of pre-identified spectra to which peptide sequences have been assigned. In order to conduct the search, we must first download the appropriate spectral library.
- Go to the Home page, and switch the pipeline type to SpectraST.
- Under the SpectraST Tools section of the navigation menu, select the Download Spectral Libraries menu item.
- You are now at at page that shows a list of spectral libraries available at PeptideAtlas, along with locally-installed/downloaded ones. Select the NIST_yeast_IT_v2.0_2008-07-11.splib.zip (yeast ion trap) library on the right pane, and click on Download Selected Libraries.
We also need to copy the mzML data files we converted in step 4 into the SpectraST data area. While this can be accomplished within Petunia, it is easier to use Windows file copy. Copy the two mzML files located at C:\Inetpub\wwwroot\ISB\data\demo2009\tandem into the directory C:\Inetpub\wwwroot\ISB\data\demo2009\spectrast (which you will need to create). Now we can move on to searching these data:
- Mouse-over the Analysis Pipeline menu title in Petunia, and then click on the SpectraST Search menu item to access the SpectraST search interface.
- In section 1, select the two mzML data files under demo2009\spectrast and click Add Files.
- For section 2, select the NIST_yeast_IT_v2.0_2008-07-11.splib.splib spectral library file located under dbase\speclibs. This is the file you downloaded from PeptideAtlas above.
- Finally, for section 3, select the yeast_orfs_all_REV.20060126.short.fasta sequence database, located under dbase.
- Leave the rest of the options on the page at their default values, and click on Run SpectraST to initiate the search.
6. Validation of Peptide-Spectrum assignments with PeptideProphet
PeptideProphet provides statistical validation of search engine results by assigning a probability to each peptide-spectrum match.
- Click on the Analyze Peptides tab under the Analysis Pipeline section in Petunia to access the xinteract interface.
xinteract is a general utility that is able to launch several components of the TPP, including PeptideProphet.
- Select the two OR2008*.pep.xml files in the directory demo2009\tandem. Make sure that there are only two files selected for analysis; you can edit the selections using the checkboxes and Remove button on the right-hand side.
- Under PeptideProphet Options, find and select the option to Use accurate mass binning since this is a high-accuracy data.
- Leave all other options set to their defaults, and click on Run XInteract at the bottom of the page to run PeptideProphet.
- Once the command finishes running, you can click on the view results link that appears in the Command Status box to view and analyze the results. IMG:PepProphet On this page, sort the list in descending order based on Probabilities. The identifications at the top of the resulting list are most likely to be correct. Click on the hypertext link for any probability. This brings up a details page IMG:PlotModel which shows graphically how successful the modeling was. In the upper pane, it is desirable for the red curve (sensitivity) to hug the upper right corner, and for the green curve (error) to hug the lower left corner. The lower pane shows how well the data (black line) follows the PeptideProphet modeling for each charge state. The blue curve describes the modeling of the negative results, and the purple one, the positive results. If these two curves are well separated and fit the black line well, then the analysis for that charge state was successful.
- You can now go back run this analysis on the SpectraST results. Again, make sure you are only analyzing two input files.
7. Visualize LC-MS/MS data using Pep3D
Pep3D is a tool for visualizing LC MS data, along with results from PeptideProphet.
- Under the Utilities -> Browse Files section in Petunia, navigate to the demo2009\tandem directory. (nB. you may already be in that directory.) You may also select the interact.pep.xml file under the spectrast folder.
- Open the PeptideProphet results file by clicking on the [ PepXML ] link next to the file named interact.pep.xml. This will launch the PepXMLViewer application.
- Click on the Other Actions top-level tab, and then on the Generate Pep3D button. A new window will launch the Pep3D viewer.
- Leave the default options (or change to taste) and click on the Generate Pep3D Image button.
- After a few moments, you should see two images displayed on the page, one per mzML input file. IMG:Pep3D
8. Further peptide-level validation iProphet
- iProphet (or InterProphet) is a tool that provides statistical refinement of PeptidePropet results.
- Click on the Combine Analyses tab under the Analysis Pipeline section in Petunia to access the iProphet interface.
- Select the interact.pep.xml file in the directory demo2009\tandem, as well as the file of the same name under the demo2009\spectrast directory. Make sure that there are two files selected for analysis; you can edit the selections using the checkboxes and Remove button on the right-hand side.
- Under Output File and Location, make sure that the File path (folder) is set to c:/Inetpub/wwwroot/ISB/data/demo2009. You may have to edit out part of the default value that is first shown.
- Leave all other options set to their defaults, and click on Run InterProphet at the bottom of the page to run iProphet.
- Once the command finishes running, you can click on the view results link that appears in the Command Status box to view and analyze the results. IMG:iprophet
9. Peptide Quantitation with ASAPRatio
- ASAPRatio is a tool for measuring relative expression levels of peptides and proteins from isotopically-labeled samples (e.g. ICAT, SILAC, etc).
- Click on the Analyze Peptides tab under the Analysis Pipeline section in Petunia to access the xinteract interface again.
- Select the interact.iproph.pep.xml file in the directory demo2009. Make sure that there is only one file selected for analysis; you can edit the selections using the checkboxes and Remove button on the right-hand side.
- Important
- Change "Write output to file:" to have the same name as the input file interact.iproph.pep.xml,
- Under PeptideProphet Options
- Make sure that you uncheck the option to RUN PeptideProphet under PeptideProphet Options,
- Under "Enter additional options to pass directly to the command-line (expert use only!)", copy the text:
-nI
- Under ASAPRatio Options
- select to RUN ASAPRatio, change Labeled Residues to K and R
- set m/z range to include in summation of peak to 0.05
- set Specified masses to M 147.035, K 136.10916, and R 166.10941.
- Leave all other options set to their defaults, and click on Run XInteract at the bottom of the page to run ASAPRatio.
- Once the command finishes running (about 4 hrs), you can click on the view results link that appears in the Command Status box to view and analyze the results. The “asapratio” column contains quantitation results with a link to the ASAPRatio ion trace. The number listed in the “asapratio” column is the light to heavy ratio. IMG:ASAPRatioProfiles
10. Protein-level validation with ProteinProphet
ProteinProphet is a tool that provides statistical validation of Protein identifications, and is based on PeptideProphet results.
- Click on the Analyze Proteins tab under the Analysis Pipeline section in Petunia to access the ProteinProphet interface.
- Select the interact.pep.xml file in the directory demo2009. Make sure that there is only one file selected for analysis; you can edit the selections using the checkboxes and Remove button on the right-hand side.
- Leave all other options set to their defaults, and click on Run ProteinProphet at the bottom of the page to run ProteinProphet.
- once the command finishes running, you can click on the view results link that appears in the Command Status box to view and analyze the results. Protein groups are sorted in descending order by Probability so that the groups at the top of the page are the most confident identifications. The protein probabilities are the red numbers listed next to each protein group. IMG:Protxml