annotate spectrast_create.xml @ 5:274fdc50169b draft default tip

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit e5b5b15b0a995c8588ff62f92fd0a2329fb7a6a5-dirty
author jjohnson
date Wed, 25 Jul 2018 15:05:34 -0400
parents c9bfe6adb7cd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
1 <tool id="specrast_create" name="SpectraST Create" version="@VERSION@.0">
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
2 <description>Spectral Library from Search Results</description>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
3 <macros>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
4 <import>macros.xml</import>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
5 </macros>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
6 <expand macro="requirements" />
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
8 ## Need to symlink to data using name with extension that spectrast recognizes
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
9 #import re
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
10 ## pepxml datasets
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
11 #set $input_files = []
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
12 #for $px in $pepxml_files:
4
c9bfe6adb7cd planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 592d86797e58318bad77de7c7de253056218cd1e-dirty
jjohnson
parents: 3
diff changeset
13 #set $input_name = $re.sub('[.]?pep[.]?xml$', '' ,$re.sub('[ ]', '_', $px.display_name.split('/')[-1])) + '.pep.xml'
3
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
14 #silent $input_files.append($input_name)
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
15 ln -s -f '${px}' '${input_name}' &&
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
16 #end for
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
17 #set $input_names = ' '.join($input_files)
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
18 python $__tool_directory__/link_scan_datasets.py
4
c9bfe6adb7cd planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 592d86797e58318bad77de7c7de253056218cd1e-dirty
jjohnson
parents: 3
diff changeset
19 #for $spectrum_file in $spectrum_files:
3
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
20 -n '$spectrum_file.display_name' -f '$spectrum_file'
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
21 #end for
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
22 $input_names &&
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
23 python $__tool_directory__/spectrast_params.py
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
24 --mode=create
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
25 #if $spectrastParams:
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
26 '$spectrastParams'
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
27 #end if
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
28 '$spectrast_params' -o spectrast_create.params &&
4
c9bfe6adb7cd planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 592d86797e58318bad77de7c7de253056218cd1e-dirty
jjohnson
parents: 3
diff changeset
29 mkdir -p outdir &&
c9bfe6adb7cd planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 592d86797e58318bad77de7c7de253056218cd1e-dirty
jjohnson
parents: 3
diff changeset
30 spectrast -cFspectrast_create.params -cN'outdir/library' $input_names &&
c9bfe6adb7cd planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 592d86797e58318bad77de7c7de253056218cd1e-dirty
jjohnson
parents: 3
diff changeset
31 find * &&
3
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
32 mkdir -p '$output.files_path' &&
4
c9bfe6adb7cd planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 592d86797e58318bad77de7c7de253056218cd1e-dirty
jjohnson
parents: 3
diff changeset
33 for i in library.splib library.sptxt library.spidx library.pepidx; do if [ -e outdir/\${i} ]; then cp -p outdir/\${i} '$output.files_path'; fi; done
3
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
34 ]]></command>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
35 <configfiles>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
36 <configfile name="spectrast_params"><![CDATA[#slurp
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
37 ]]>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
38 @LIBRARY_CREATE_OPTIONS@
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
39 @LIBRARY_IMPORT_OPTIONS@
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
40 </configfile>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
41 </configfiles>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
42 <inputs>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
43 <param name="pepxml_files" multiple="true" type="data" format="pepxml,peptideprophet_pepxml,interprophet_pepxml" label="PepXML Files to use in library generation" help=""/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
44 <param name="spectrum_files" multiple="true" type="data" format="mzxml" label="Data files containing spectra referred to in pepxml files" help=""/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
45 <param name="spectrastParams" type="data" format="txt" optional="true" label="SpectraST param file" help=""/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
46 <expand macro="library_create_options"/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
47 <expand macro="library_import_options"/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
48 </inputs>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
49 <outputs>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
50 <data name="log" format="txt" label="spectrast.log" from_work_dir="spectrast.log"/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
51 <data name="params" format="txt" label="spectrast_create.params" from_work_dir="spectrast_create.params"/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
52 <expand macro="library_create_outputs"/>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
53 <data name="output" format="splib" label="libary.splib" />
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
54 </outputs>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
55 <tests>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
56 <test>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
57 </test>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
58 </tests>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
59 <help><![CDATA[
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
60 **Create Libraries from Sequence Search Results**
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
61
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
62 Note: As per TPP convention, the spectrum query must be named:
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
63 <mzXML file name>.<start scan>.<end scan>.<charge>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
64 in the .pepXML file, so that SpectraST knows where to find the corresponding experimental spectrum. (If the .pepXML file is created with TPP tools, this should not be an issue.)
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
65
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
66 SpectraST can create a spectral library from a .pepXML file, which contains peptide identifications from a previous shotgun proteomics experiment. For this purpose, it is preferable that the .pepXML has been processed with PeptideProphet and/or iProphet, such that all the search hits have probabilities assigned. (iProphet probabilities are used over PeptideProphet ones if both are present.)
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
67
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
68 When importing from a .pepXML file, SpectraST scans through the .pepXML file for confident identifications, and attempts to extract the corresponding experimental spectra from .mzXML files.
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
69 ]]></help>
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
70 <expand macro="citations" />
7f02fc51bddf planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/spectrast commit 379705f578f9a0465f497894c7d2b5f68b6a55e6-dirty
jjohnson
parents:
diff changeset
71 </tool>