annotate map_aligner_spectrum.xml @ 4:1183846e70a1 draft

Uploaded
author galaxyp
date Wed, 19 Jun 2013 13:15:44 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
1 <tool id="openms_map_aligner_spectrum" version="0.1.0" name="Map Aligner (Spectrum)">
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
2 <description>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
3 Corrects retention time distortions between maps by aligning spectra.
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
4 </description>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
5 <macros>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
6 <import>macros.xml</import>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
7 </macros>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
8 <expand macro="stdio" />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
9 <expand macro="requires" />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
10 <command interpreter="python">
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
11 openms_wrapper.py --executable 'MapAlignerSpectrum' --config $config
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
12 </command>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
13 <configfiles>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
14 <configfile name="config">[simple_options]
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
15 #set $inputs_as_str = ",".join(map(str, $input))
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
16 in=$inputs_as_str
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
17 out=@MULTI_OUTPUT($output.extra_files_path,$inputs_as_str)@
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
18 #if $generate_transformations
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
19 trafo_out=@MULTI_OUTPUT($transformations.extra_files_path,$inputs_as_str)@
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
20 #end if
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
21 algorithm!gapcost=$gapcost
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
22 algorithm!affinegapcost=$affinegapcost
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
23 algorithm!scorefunction=$scorefunction
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
24 #set $model_type = $model.model_type
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
25 model!type=$model_type
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
26 #if $model_type == "interpolated"
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
27 model!interpolated!interpolation_type=$model.interpolation_type
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
28 #end if
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
29 </configfile>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
30 </configfiles>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
31 <inputs>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
32 <param format="m:mzml" name="input" type="data" label="Input Peak Lists" />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
33 <param name="generate_transformations" type="boolean" label="Generate Transformations" />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
34 <param name="gapcost" type="float" value="1.0" label="Gap Cost" help="This Parameter stands for the cost of opining a gap in the Alignment. A Gap means that one Spectrum can not be aligned directly to another Spectrum in the Map. This happens, when the similarity of both spectra a too low or even not present. Imagen as a insert or delete of the spectrum in the map. The gap is necessary for aligning, if we open a gap there is a possibility that an another spectrum can be correct aligned with a higher score as before without gap. But to open a gap is a negative event and has to be punished a bit, so such only in case it 's a good choice to open a gap, if the score is bad enough. The Parameter is to giving as a positive number, the implementation convert it to a negative number." />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
35 <param name="affinegapcost" type="float" value="0.5" label="Affine Gap Cost" help="This Parameter controls the cost of extension a already open gap. The idea behind the affine gapcost lies under the assumption, that it is better to get a long distance of connected gaps than to have a structure gap match gap match. There for the punishment for the extension of a gap has to be lower than the normal gapcost. If the the result of the aligmnet show high compression, it is a good idea to lower the affine gapcost or the normal gapcost." />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
36 <param name="scorefunction" type="select" label="Score Function" help="The score function is the core of an alignment. The success of an alignment depends mostly of the elected score function. The score function return the similarity of two Spectrum back. The score influence defines later the way of possible traceback. There exist many way of algorithm to calculate the score.">
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
37 <option value="SteinScottImproveScore">SteinScottImproveScore</option>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
38 <option value="ZhangSimilarityScore">ZhangSimilarityScore</option>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
39 </param>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
40 <expand macro="aligner_model" />
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
41 </inputs>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
42 <outputs>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
43 <data format="m:mzml" name="output" label="Alignment of ${on_string}">
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
44 </data>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
45 <data format="m:trafoxml" name="transformations" label="Aligned Transformations for ${on_string}">
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
46 <filter>generate_transformations</filter>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
47 </data>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
48 </outputs>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
49 <help>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
50 **What it does**
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
51
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
52 This tool provides an algorithm to align the retention time scales of multiple input files, correcting shifts and distortions between them. Retention time adjustment may be necessary to correct for chromatography differences e.g. before data from multiple LC-MS runs can be combined (feature grouping), or when one run should be annotated with peptide identifications obtained in a different run.
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
53
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
54 All map alignment tools (MapAligner...) collect retention time data from the input files and - by fitting a model to this data - compute transformations that map all runs to a common retention time scale. They can apply the transformations right away and return output files with aligned time scales (parameter out), and/or return descriptions of the transformations in trafoXML format (parameter trafo_out). Transformations stored as trafoXML can be applied to arbitrary files with the MapRTTransformer tool.
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
55
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
56 The map alignment tools differ in how they obtain retention time data for the modeling of transformations, and consequently what types of data they can be applied to. Here, an experimental algorithm based on spectrum alignment is implemented. It is only applicable to peak maps (mzML format).
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
57
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
58 **Citation**
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
59
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
60 For the underlying tool, please cite ``Weisser et al.: An automated pipeline for high-throughput label-free quantitative proteomics (J. Proteome Res., 2013, PMID: 23391308).``
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
61
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
62 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
63 </help>
1183846e70a1 Uploaded
galaxyp
parents:
diff changeset
64 </tool>