annotate scaffold.xml @ 0:e9981e6af666 draft

Improved some datatype handling
author galaxyp
date Thu, 20 Jun 2013 11:07:47 -0400
parents
children 0d0cbb69a03f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
1 <tool id="scaffold" name="Scaffold" version="0.1.0">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
2 <description>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
3 Visualize and Validate Complex MS/MS Proteomics Experiments
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
4 </description>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
5 <configfiles>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
6 <configfile name="sample_config"># Simple format group:group_name followed by pairs of name:name and path:path lines
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
7 #if $sample_mode.mode == "full"
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
8 #set $samples = $sample_mode.samples
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
9 #for $sample in $samples:
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
10 #if $sample.category.specify
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
11 #set $category = $sample.category.name
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
12 #else
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
13 #set $category = $sample.sample_name
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
14 #end if
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
15 sample:$sample.sample_name
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
16 mudpit:$sample.mudpit
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
17 category:$category
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
18 #for $sample_input in $sample.sample_inputs:
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
19 name:${sample_input.display_name}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
20 path:${sample_input}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
21 ext:${sample_input.ext}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
22 #end for
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
23 #end for
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
24 #elif $sample_mode.mode == "sample_per_file":
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
25 #for $sample_input in $sample_mode.sample_inputs:
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
26 sample:${sample_input.display_name}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
27 mudpit:false
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
28 category:${sample_input.display_name}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
29 name:${sample_input.display_name}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
30 path:${sample_input}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
31 ext:${sample_input.ext}
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
32 #end for
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
33 #end if
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
34 </configfile>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
35 </configfiles>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
36 <command interpreter="python">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
37 scaffold_wrapper.py run \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
38 --samples $sample_config \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
39 --database $database \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
40 --database_name '$database.display_name'\
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
41 --output $output \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
42 --database_type $database_type \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
43 --database_decoy_regex '$database_decoy_regex' \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
44 #if $thresholds.specify
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
45 --protein_probability '$thresholds.protein_probability' \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
46 --peptide_probability '$thresholds.peptide_probability' \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
47 #end if
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
48 #if $advanced.specify
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
49 #if $advanced.output_driver
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
50 --output_driver $output_drirver \
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
51 #end if
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
52 #end if
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
53 </command>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
54 <inputs>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
55 <param format="fasta" name="database" type="data" label="Search Database" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
56 <param type="select" name="database_type" label="Database Type">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
57 <option value="GENERIC">Generic</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
58 <option value="ESTNR">EST/NR (NCBI)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
59 <option value="IPI">IPI (EBI)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
60 <option value="SWISSPROT">Swiss-Prot (SIB/EBI)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
61 <option value="UNIPROT">UniProt/Swiss-Prot (UniProtKB)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
62 <option value="UNIREF">UniRef/NREF (UniProt)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
63 <option value="ENSEMBL">Ensembl (EMBL/EBI)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
64 <option value="MSDB">MSDB (Proteomics Group)</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
65 </param>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
66 <param name="database_decoy_regex" type="text" label="Database Decoy Prefix" help="Regular expression describing decoys in specified FASTA databse." value="REV|RRR">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
67 <sanitizer>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
68 <valid initial="string.printable">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
69 <add value="|"/>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
70 </valid>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
71 </sanitizer>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
72 </param>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
73 <conditional name="sample_mode">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
74 <param name="mode" type="select" label="How should samples be created">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
75 <option value="full">Create Samples Manually</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
76 <option value="sample_per_file">Create Sample per File</option>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
77 </param>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
78 <when value="full">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
79 <repeat name="samples" title="Biological Sample">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
80 <param name="sample_name" type="text" label="Sample Name" help="Name for the scample (use only letters and numbers)." />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
81 <param format="t.xml,omx" name="sample_inputs" type="data" multiple="true" label="Sample Input Files" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
82 <param name="mudpit" type="boolean" label="Mudpit" help="" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
83 <conditional name="category">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
84 <param name="specify" type="boolean" label="Specify Custom Category" help="" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
85 <when value="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
86 <when value="true">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
87 <param name="name" type="text" label="Category Name" help="" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
88 </when>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
89 </conditional>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
90 </repeat>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
91 </when>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
92 <when value="sample_per_file">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
93 <param format="t.xml,omx" name="sample_inputs" type="data" multiple="true" label="Input Files" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
94 </when>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
95 </conditional>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
96 <conditional name="thresholds">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
97 <param name="specify" type="boolean" label="Specify Reporting Thresholds" help="" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
98 <when value="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
99 <when value="true">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
100 <param name="protein_probability" type="float" label="Minimum Protein Probility" help="Optional value between 0.0 and 1.0." optional="true" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
101 <param name="peptide_probability" type="float" label="Minimum Peptide Probility" help="Optional value between 0.0 and 1.0." optional="true" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
102 </when>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
103 </conditional>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
104 <conditional name="advanced">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
105 <param name="specify" type="boolean" label="Specify Advanced Options" help="" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
106 <when value="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
107 <when value="true">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
108 <param name="output_driver" type="boolean" label="Include Scaffold Driver File in Output" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
109 <!--
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
110 <param name="ncbi_annotate" type="boolean" label="" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
111 <param name="go_annotate" type="boolean" label="" truevalue="true" falsevalue="false" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
112 -->
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
113 </when>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
114 </conditional>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
115 </inputs>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
116 <outputs>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
117 <data format="xml" name="output_drirver" label="Scaffold Driver for ${on_string}">
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
118 <filter>(advanced['specify'] and advanced["output_driver"])</filter>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
119 </data>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
120 <data format="sf3" name="output" />
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
121 </outputs>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
122 <requirements>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
123 <requirement type="package">scaffold</requirement>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
124 </requirements>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
125 <help>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
126 **What it does**
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
127
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
128 Merges multiple protein identification search results together into a single SF3 file for viewing. A free viewer for Scaffold SF3 files can be obtained from Proteome software at http://www.proteomesoftware.com/Scaffold/Scaffold_viewer.htm.
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
129
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
130 ------
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
131
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
132
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
133 **Citation**
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
134
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
135 For the underlying tool, please cite `TODO`
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
136
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
137 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-scaffold
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
138 </help>
e9981e6af666 Improved some datatype handling
galaxyp
parents:
diff changeset
139 </tool>