annotate saint_wrapper.xml @ 8:67631a640534 draft default tip

Uploaded
author bornea
date Mon, 18 Apr 2016 10:33:12 -0400
parents 3115fed97d4a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
1 <tool id="saint_wrapper" name="SAINTexpress">
3115fed97d4a Uploaded
bornea
parents:
diff changeset
2 <description></description>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
3 <command interpreter="python">saint_wrapper.py $inter_input $prey_input $bait_input $rep_num $vc_bool $vc_num $go_bool $go_file $SAINT_output \$INSTALL_RUN_PATH/</command>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
4 <requirements>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
5 <requirement type="set_environment">INSTALL_RUN_PATH</requirement>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
6 </requirements>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
7 <inputs>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
8 <param format="txt" name="inter_input" type="data" label="Interactions File"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
9 <param format="txt" name="prey_input" type="data" label="Prey File"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
10 <param format="txt" name="bait_input" type="data" label="Bait File"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
11 <param name="rep_num" type="integer" value="100" label="Number of Replicates" help="the number of replicates (with largest spectral counts or intensities) to be used for probability calculation in each bait. This option is useful when some baits have more replicates than others." />
3115fed97d4a Uploaded
bornea
parents:
diff changeset
12 <param type="boolean" name="vc_bool" checked="false" label="Using Virtual Control Purifications by Compression"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
13 <param name="vc_num" type="integer" value="1" label="Number of Virtual Controls" />
3115fed97d4a Uploaded
bornea
parents:
diff changeset
14 <param type="boolean" name="go_bool" checked="false" label="Incorporate External Data Sources" />
3115fed97d4a Uploaded
bornea
parents:
diff changeset
15 <param format="txt" name="go_file" type="data" optional="true" label="External Data File" help="SAINT can be run with the known interaction data in hand and it will incorporate the number of observed interactions into the statistics to boost identification probability."/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
16 </inputs>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
17 <outputs>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
18 <data format="txt" name="SAINT_output" />
3115fed97d4a Uploaded
bornea
parents:
diff changeset
19 </outputs>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
20 <stdio>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
21 <regex match="Error|error"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
22 source="stdout"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
23 level="fatal"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
24 description="Unknown error"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
25 <regex match="Error|error"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
26 source="stderr"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
27 level="fatal"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
28 description="Unknown error"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
29 <regex match="Error: bad bait"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
30 source="stdout"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
31 level="fatal"
3115fed97d4a Uploaded
bornea
parents:
diff changeset
32 description="Error: bad bait"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
33 </stdio>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
34
3115fed97d4a Uploaded
bornea
parents:
diff changeset
35 <tests>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
36 <test>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
37 <param name="input" value="fa_gc_content_input.fa"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
38 <output name="out_file1" file="fa_gc_content_output.txt"/>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
39 </test>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
40 </tests>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
41 <help>
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
42 SAINTexpress
67631a640534 Uploaded
bornea
parents: 6
diff changeset
43 ------------
67631a640534 Uploaded
bornea
parents: 6
diff changeset
44
67631a640534 Uploaded
bornea
parents: 6
diff changeset
45 This tool will read in a *Bait File, Prey File,* and *Inter File* and
67631a640534 Uploaded
bornea
parents: 6
diff changeset
46 analyze them using the latest version of SAINTexpress.
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
47
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
48 **1) Interactions File**
67631a640534 Uploaded
bornea
parents: 6
diff changeset
49
67631a640534 Uploaded
bornea
parents: 6
diff changeset
50 Please specify an *Inter* file for SAINTexpress analysis. An *Inter*
67631a640534 Uploaded
bornea
parents: 6
diff changeset
51 file should contain four columns: IP name, bait name, prey name, and
67631a640534 Uploaded
bornea
parents: 6
diff changeset
52 spectral counts or intensity values, depending on the mode of
67631a640534 Uploaded
bornea
parents: 6
diff changeset
53 quantification.
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
54
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
55 **2) Prey File**
67631a640534 Uploaded
bornea
parents: 6
diff changeset
56
67631a640534 Uploaded
bornea
parents: 6
diff changeset
57 Please specify a *Prey* file for SAINTexpress analysis. A *Prey* file
67631a640534 Uploaded
bornea
parents: 6
diff changeset
58 should contain three columns: prey (protein) name, prey amino acid
67631a640534 Uploaded
bornea
parents: 6
diff changeset
59 length, and prey gene name.
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
60
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
61 **3) Bait File**
67631a640534 Uploaded
bornea
parents: 6
diff changeset
62
67631a640534 Uploaded
bornea
parents: 6
diff changeset
63 Please specify a *Bait* file for SAINTexpress analysis. A *Bait* file
67631a640534 Uploaded
bornea
parents: 6
diff changeset
64 should have three columns: IP name, bait name, and the indicator for
67631a640534 Uploaded
bornea
parents: 6
diff changeset
65 test and negative control purifications.
67631a640534 Uploaded
bornea
parents: 6
diff changeset
66
67631a640534 Uploaded
bornea
parents: 6
diff changeset
67 **4) Number of Replicates**
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
68
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
69 The number of replicates (with largest spectral counts or intensities)
67631a640534 Uploaded
bornea
parents: 6
diff changeset
70 to be used for probability calculation in each bait. This option is
67631a640534 Uploaded
bornea
parents: 6
diff changeset
71 useful when some baits have more replicates than others.
67631a640534 Uploaded
bornea
parents: 6
diff changeset
72
67631a640534 Uploaded
bornea
parents: 6
diff changeset
73 **5) Using Virtual Control Purifications by Compression**
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
74
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
75 Sets the number of virtual control purifications by compression. For
67631a640534 Uploaded
bornea
parents: 6
diff changeset
76 instance, if you wish to take 4 largest spectral counts for controls,
67631a640534 Uploaded
bornea
parents: 6
diff changeset
77 set **Number of Vitual Controls** to 4 and this variable to Yes.
67631a640534 Uploaded
bornea
parents: 6
diff changeset
78
67631a640534 Uploaded
bornea
parents: 6
diff changeset
79 **6) Number of Virtual Controls**
67631a640534 Uploaded
bornea
parents: 6
diff changeset
80
67631a640534 Uploaded
bornea
parents: 6
diff changeset
81 Specify the number of virtual control purifications by compression.
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
82
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
83 **7) Incorporate External Data Sources**
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
84
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
85 To incorporate external data sources for computing the Topology-Aware
67631a640534 Uploaded
bornea
parents: 6
diff changeset
86 Probability Score (TopoAvgP), the user must also provide the interaction
67631a640534 Uploaded
bornea
parents: 6
diff changeset
87 database file that contains two columns: interaction identifier column
67631a640534 Uploaded
bornea
parents: 6
diff changeset
88 and interaction/grouping information column. The first column is just
67631a640534 Uploaded
bornea
parents: 6
diff changeset
89 for formality and thus can be filled in with anything (no white space)
67631a640534 Uploaded
bornea
parents: 6
diff changeset
90 and it will not be utilized in the scoring. The second column must be
67631a640534 Uploaded
bornea
parents: 6
diff changeset
91 formatted as a list of prey identifiers (consistent with the first
67631a640534 Uploaded
bornea
parents: 6
diff changeset
92 column of the prey file) separated by a white space.
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
93
8
67631a640534 Uploaded
bornea
parents: 6
diff changeset
94 **8) External Data File**
67631a640534 Uploaded
bornea
parents: 6
diff changeset
95
67631a640534 Uploaded
bornea
parents: 6
diff changeset
96 Specify external data file
67631a640534 Uploaded
bornea
parents: 6
diff changeset
97
67631a640534 Uploaded
bornea
parents: 6
diff changeset
98 --------
6
3115fed97d4a Uploaded
bornea
parents:
diff changeset
99
3115fed97d4a Uploaded
bornea
parents:
diff changeset
100 **Please cite**
3115fed97d4a Uploaded
bornea
parents:
diff changeset
101
3115fed97d4a Uploaded
bornea
parents:
diff changeset
102 * Choi, H., Larsen, B., Lin., Z.-Y., Breitkreutz, A., Mellacheruvu, D., Fermin, D., Qin, Z.S., Tyers, M., Gingras, A.-C. and Nesvizhskii, A.I. (2011) SAINT: probabilistic scoring of affinity purification - mass spectrometry data. Nature Methods, 8:70-3.
3115fed97d4a Uploaded
bornea
parents:
diff changeset
103
3115fed97d4a Uploaded
bornea
parents:
diff changeset
104 </help>
3115fed97d4a Uploaded
bornea
parents:
diff changeset
105 </tool>