Mercurial > repos > galaxyp > dialignr

comparison dialignr.xml @ 0:e043b4b07470 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/dialignr commit 8dd046346db8261c462e2f3f5b4ff7f2433348df"
author galaxyp
date Wed, 30 Dec 2020 20:12:32 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:e043b4b07470
1 <tool id="dialignr" name="DIAlignR" version="@WRAPPER_VERSION@">
2 <description>for retention time alignment of targeted mass spectrometric data</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <requirements>
7 <requirement type="package" version="@TOOL_VERSION@">bioconductor-dialignr</requirement>
8 </requirements>
9 <command detect_errors="exit_code"><![CDATA[
10 #import re
11
12 mkdir -p ./data/mzml &&
13 mkdir -p ./data/osw &&
14
15 #for $mzml in $input_mzml_files:
16 #set $file_name_mzml = re.sub('[^\w\-_.]', '_', str($mzml.element_identifier))
17 echo '$file_name_mzml' >> ./runs.txt &&
18 ln -s '$mzml' './data/mzml/${file_name_mzml}.chrom.mzML' &&
19 #end for
20
21 #if $input_osw_file:
22 ln -s '$input_osw_file' './data/osw/merged.osw' &&
23 #end if
24
25 Rscript --vanilla '${__tool_directory__}/dialignr.R'
26 #if $input_osw_file:
27 --oswMerged 'TRUE'
28 #else:
29 --oswMerged 'FALSE'
30 #end if
31 --maxFdrQuery '${$adv_params.maxFdrQuery}'
32 --XICfilter '${$adv_params.XICfilter}'
33 --polyOrd '${adv_params.polyOrd}'
34 --kernelLen '${adv_params.kernelLen}'
35 --globalAlignment '${adv_params.globalAlignment}'
36 --globalAlignmentFdr '${adv_params.globalAlignmentFdr}'
37 --globalAlignmentSpan '${adv_params.globalAlignmentSpan}'
38 --RSEdistFactor '${adv_params.RSEdistFactor}'
39 --normalization '${adv_params.normalization}'
40 --simMeasure '${adv_params.simMeasure}'
41 --alignType '${adv_params.alignType}'
42 --goFactor '${adv_params.goFactor}'
43 --geFactor '${adv_params.geFactor}'
44 --cosAngleThresh '${adv_params.cosAngleThresh}'
45 --OverlapAlignment '${adv_params.OverlapAlignment}'
46 --dotProdThresh '${adv_params.dotProdThresh}'
47 --gapQuantile '${adv_params.gapQuantile}'
48 --hardConstrain '${adv_params.hardConstrain}'
49 --samples4gradient '${adv_params.samples4gradient}'
50 --analyteFDR '${adv_params.analyteFDR}'
51 --unalignedFDR '${adv_params.unalignedFDR}'
52 --alignedFDR '${adv_params.alignedFDR}'
53 --baselineType '${adv_params.baselineType}'
54 --integrationType '${adv_params.integrationType}'
55 --fitEMG '${adv_params.fitEMG}'
56 --recalIntensity '${adv_params.recalIntensity}'
57 --fillMissing '${adv_params.fillMissing}'
58 --smoothPeakArea '${adv_params.smoothPeakArea}'
59 &&
60
61 cat alignedTargetedRuns.csv | sed 's/,/\t/g' > alignedTargetedRuns.tsv
62 ]]></command>
63 <inputs>
64 <param name="input_mzml_files" type="data" format="mzml" multiple="true" label="MZML file(s)" help="Sample file(s) in .MZML format." />
65 <param name="input_osw_file" type="data" format="osw" optional="true" multiple="false" label="OSW file" help="Sample file in .OSW format." />
66 <section name="adv_params" title="Advanced parameters">
67 <param name="maxFdrQuery" type="float" min="0" max="1" value="0.05" label="Maximum FDR query" help="Numeric value between 0 and 1. It is used to filter features from osw file which have SCORE_MS2.QVALUE less than itself." />
68 <param name="XICfilter" type="select">
69 <option value="sgolay" selected="true">sgolay</option>
70 <option value="boxcar">boxcar</option>
71 <option value="gaussian">gaussian</option>
72 <option value="loess ">loess</option>
73 <option value="none">none</option>
74 </param>
75 <param name="polyOrd" type="integer" min="0" value="4" label="Order of the polynomial to be fit in the kernel" />
76 <param name="kernelLen" type="integer" min="0" value="9" label="Number of data-points to consider in the kernel" />
77 <param name="globalAlignment" type="select" label="Global alignment">
78 <option value="loess" selected="true">loess</option>
79 <option value="linear">linear</option>
80 </param>
81 <param name="globalAlignmentFdr" type="float" min="0" max="1" value="0.01" label="Global alignment FDR" help="Numeric value between 0 and 1. Features should have m-score lower than this value for participation in LOESS fit." />
82 <param name="globalAlignmentSpan" type="float" min="0" max="1" value="0.1" label="Global alignment Span" help="Span value for LOESS fit. For targeted proteomics 0.1 could be used." />
83 <param name="RSEdistFactor" type="float" min="0" value="3.5" label="RSE distance" help="Defines how much distance in the unit of rse remains a noBeef zone." />
84 <param name="normalization" type="select" label="Normalization">
85 <option value="mean" selected="true">mean</option>
86 <option value="12">12</option>
87 </param>
88 <param name="simMeasure" type="select" label="SIM measure">
89 <option value="dotProduct">dotProduct</option>
90 <option value="cosineAngle">cosineAngle</option>
91 <option value="cosine2Angle">cosine2Angle</option>
92 <option value="dotProductMasked" selected="true">dotProductMasked</option>
93 <option value="euclideanDist">euclideanDist</option>
94 <option value="covariance">covariance</option>
95 <option value="correlation">correlation</option>
96 </param>
97 <param name="alignType" type="select" label="Alignment method">
98 <option value="global">global</option>
99 <option value="local">local</option>
100 <option value="hybrid" selected="true">hybrid</option>
101 </param>
102 <param name="goFactor" type="float" min="0" value="0.125" label="Gap penalty (first gap)" help="Penalty for introducing first gap in alignment. This value is multiplied by base gap-penalty." />
103 <param name="geFactor" type="float" min="0" value="40" label="Gap penalty (subsequent gaps)" help="Penalty for introducing subsequent gaps in alignment. This value is multiplied by base gap-penalty." />
104 <param name="cosAngleThresh" type="float" min="0" value="0.3" label="cosAngleTresh" help="In SIM measure = dotProductMasked mode, angular similarity should be higher than cosAngleThresh otherwise similarity is forced to zero." />
105 <param name="OverlapAlignment" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Overlap alignment" help="An input for alignment with free end-gaps. No: Global alignment Yes: Overlap alignment" />
106 <param name="dotProdThresh" type="float" min="0" value="0.96" label="dotProdThresh" help="In SIM measure = dotProductMasked mode, values in similarity matrix higher than dotProdThresh quantile are checked for angular similarity." />
107 <param name="gapQuantile" type="float" min="0" max="1" value="0.5" label="Gap quantile" help="Must be between 0 and 1. This is used to calculate base gap-penalty from similarity distribution." />
108 <param name="hardConstrain" type="boolean" truevalue="TRUE" falsevalue="FALSE" label="Hard constrain" help="No: Indices farther from noBeef distance are filled with distance from linear fit line." />
109 <param name="samples4gradient" type="float" min="0" value="100" label="Samples for gradient" help="Modulates penalization of masked indices." />
110 <param name="analyteFDR" type="float" min="0" max="1" value="0.01" label="Analyte FDR" help="Defines the upper limit of FDR on a precursor to be considered for multipeptide." />
111 <param name="unalignedFDR" type="float" min="0" max="1" value="0.01" label="Unaligned FDR" help="Must be between 0 and maxFdrQuery. Features below unalignedFDR are considered for quantification even without the RT alignment." />
112 <param name="alignedFDR" type="float" min="0" max="1" value="0.05" label="Aligned FDR" help="Must be between unalignedFDR and 1. Features below alignedFDRare considered for quantification after the alignment." />
113 <param name="baselineType" type="select" label="Baseline method" help="Method to estimate the background of a peak contained in XICs.">
114 <option value="base_to_base" selected="true">base to base</option>
115 <option value="vertical_division_min">vertical division min</option>
116 <option value="vertical_division_max">vertical division max</option>
117 </param>
118 <param name="integrationType" type="select" label="Integration method" help="Method to compute the area of a peak contained in XICs.">
119 <option value="intensity_sum" selected="true">intensity sum</option>
120 <option value="trapezoid">trapezoid</option>
121 <option value="simpson">simpson</option>
122 </param>
123 <param name="fitEMG" type="boolean" truevalue="TRUE" falsevalue="FALSE" label="Fit EMG" help="Enable/disable exponentially modified gaussian peak model fitting." />
124 <param name="recalIntensity" type="boolean" truevalue="TRUE" falsevalue="FALSE" label="Recal intensity" help="Recalculate intensity for all analytes." />
125 <param name="fillMissing" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Fill missing" help="Calculate intensity for analytes for which features are not found." />
126 <param name="smoothPeakArea" type="boolean" truevalue="TRUE" falsevalue="FALSE" label="Smooth peak area" help="No: Raw chromatograms will be used for quantification. Yes: Smoothed chromatograms will be used for quantification." />
127 </section>
128 </inputs>
129 <outputs>
130 <data name="out_aligned_targeted_runs" format="tabular" label="${tool.name} on ${on_string}: alignedTargetedRuns.tsv" from_work_dir="alignedTargetedRuns.tsv" />
131 </outputs>
132 <tests>
133 <test>
134 <param name="input_mzml_files" ftype="mzml" value="hroest_K120809_Strep0_PlasmaBiolRepl2_R04_SW_filt,hroest_K120809_Strep10_PlasmaBiolRepl2_R04_SW_filt" />
135 <param name="input_osw_file" ftype="osw" value="merged.osw" />
136 <output name="out_aligned_targeted_runs" file="alignedTargetedRuns.tsv" />
137 </test>
138 <test>
139 <param name="input_mzml_files" ftype="mzml" value="hroest_K120809_Strep0_PlasmaBiolRepl2_R04_SW_filt,hroest_K120809_Strep10_PlasmaBiolRepl2_R04_SW_filt" />
140 <param name="input_osw_file" ftype="osw" value="merged.osw" />
141 <param name="adv_params|maxFdrQuery" value="0.001" />
142 <output name="out_aligned_targeted_runs" file="alignedTargetedRuns_fdr.tsv" />
143 </test>
144 </tests>
145 <help><![CDATA[
146 DIAlignR
147 =============
148
149 DIAlignR is an R package for retention time alignment of targeted mass spectrometric data, including DIA and SWATH-MS data. This tool works with MS2 chromatograms directly and uses dynamic programming for alignment of raw chromatographic traces. DIAlignR uses a hybrid approach of global (feature-based) and local (raw data-based) alignment to establish correspondence between peaks.
150
151 For more information see the DIAlignR documentation_.
152
153 .. _documentation: https://github.com/shubham1637/DIAlignR
154
155 ]]></help>
156 <citations>
157 <citation type="doi">10.1074/mcp.TIR118.001132</citation>
158 </citations>
159 </tool>