changeset 20:0ac97a6298c2 draft

Uploaded
author bornea
date Thu, 14 Apr 2016 17:24:05 -0400
parents 9329d9ec60b0
children d9592cc1df99
files SAINT_preprocessing.xml
diffstat 1 files changed, 37 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/SAINT_preprocessing.xml	Thu Apr 14 17:23:45 2016 -0400
+++ b/SAINT_preprocessing.xml	Thu Apr 14 17:24:05 2016 -0400
@@ -71,20 +71,50 @@
     </test>
   </tests>
   <help>
+# Pre-Processing
 
-Pre-processing:
+* * *
+
+This tool will read in a Scaffold _Samples Report_ file (tab-delimited txt file) or a MaxQuant _peptides.txt_ file and process them to generate a _Bait File, Prey File,_ and _Inter File_ for SAINTexpress analysis.
+
+#### 1) MaxQuant or Scaffold
+
+APOSTL is able to recognize either a Scaffold _Samples Report_ file (tab-delimited txt file) or the _peptides.txt_ file output in the MaxQuant _txt_ output folder. No modifications should be made to these files. Please designate which one is being provided.
 
-APOSTL is able to recognize either a Scaffold "Samples Report" file (tab-delimited txt file) or the "peptides.txt" file output in the MaxQuant "txt" output folder. No modifications should be made to these files. Using the "Bait Create" tool, you can create your "bait.txt" file. It is important that the individual bait names match the bait names within your scaffold or MaxQuant output. APOSTL uses the bait file to findthe user's baits of interest. Additionally there is an option to make the prey file (Y/N). When making a prey file, APOSTL queries Uniprot ( http://www.uniprot.org ) in order to extract protein amino acidlengths and gene names. This takes several minutes depending on your internet connection. Some users may want to run SAINTexpress using the same data set while changing which baits are considered test or control It is useful to toggle "Make Prey" off in order to save time by circumventing this step as the same prey file can be used for both SAINTexpress runs. 
+#### 2) Scaffold or MaxQuant File Input
+
+Select the corresponding _Samples Report_ or _peptides.txt_ here.
+
+#### 3) Create Prey File
 
-INPUTS:
+Select whether or not you would like APOSTL to generate a prey file.
+
+When making a prey file, APOSTL queries a user provided FASTA database (see below) in order to extract protein amino acid lengths and gene names. This may take several minutes depending on your computer and if your Galaxy distribution is cluster enabled. Some users may want to run SAINTexpress using the same data set while changing which baits are considered test or control. It is useful to toggle **Create Prey File** off in order to save time by circumventing this step as the same prey file can be used for both SAINTexpress runs.
+
+#### 4) Provide Uniprot FASTA database
 
-Scaffold file:
+Please specify a FASTA file containing the protein sequence. You can download the latest release of Uniprot's reviewed sequences (Swiss-Prot) [here](http://www.uniprot.org/downloads). For computing efficiency, please limit your FASTA file to your species of interest. It is generally advised to use the same FASTA database that was used for your database searches during peptide and protein ID.
+
+#### 5) Are You Providing Your Own Bait File?
+
+Users have two options for providing a _Bait_ file. If you would like to create your own _Bait_ file, select <kbd>Yes</kbd> and designate the file below. If you would like to use the **Bait Create** tool to create a _Bait_ file within Galaxy, please select <kbd>No</kbd> and proceed to the **Bait Create** tool.
 
-- Scaffold "Samples Report" output (tab-delimited txt file)
+#### 6) Bait File
+
+If you selected <kbd>Yes</kbd> above, please specify the _Bait_ file you would like to provide. If you selected <kbd>No</kbd> above, ignore this argument and proceed to the **Bait Create** tool.
+
+> **Note:** Individual bait names must match to the sample names within your Scaffold or MaxQuant output exactly and must contain no whitespace characters (e.g. spaces) or dashes.
 
+#### 7) Bait Create
 
-MaxQuant file:
+Using the **Bait Create** tool, you can create your _bait.txt_ file.
+
+> **Note:** Individual bait names must match to the sample names within your Scaffold or MaxQuant output exactly and must contain no whitespace characters (e.g. spaces) or dashes.
 
-- MaxQuant "peptides.txt" file (tab-delimited txt file)
+APOSTL uses this bait file to find the user's baits of interest within a _Samples Report_ or _peptides.txt_ file and when preparing the _inter.txt_ file.
+
+* * *
+
+Once your parameters have been finalized, please press the <kbd>Execute</kbd> button to start processing. This may take a few minutes. Once your process has been completed, you will see your _Bait File, Prey File,_ and _Inter File_ on the right hand side of your panel highlighted in green.
   </help>
 </tool>