annotate ctd/ConsensusMapNormalizer.ctd @ 18:6daaa75ccb99 draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
author galaxyp
date Sun, 13 Dec 2020 15:03:50 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
2 <tool ctdVersion="1.7" version="2.6.0-pre-exported-20201001" name="ConsensusMapNormalizer" docurl="http://www.openms.de/documentation/TOPP_ConsensusMapNormalizer.html" category="Map Alignment" >
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
3 <description><![CDATA[Normalizes maps of one consensusXML file]]></description>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
4 <manual><![CDATA[Normalizes maps of one consensusXML file]]></manual>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
5 <citations>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
6 <citation doi="10.1038/nmeth.3959" url="" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
7 </citations>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
8 <PARAMETERS version="1.7.0" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/OpenMS/OpenMS/develop/share/OpenMS/SCHEMAS/Param_1_7_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
9 <NODE name="ConsensusMapNormalizer" description="Normalizes maps of one consensusXML file">
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
10 <ITEM name="version" value="2.6.0-pre-exported-20201001" type="string" description="Version of the tool that generated this parameters file." required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
11 <NODE name="1" description="Instance &apos;1&apos; section for &apos;ConsensusMapNormalizer&apos;">
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
12 <ITEM name="in" value="" type="input-file" description="input file" required="true" advanced="false" supported_formats="*.consensusXML" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
13 <ITEM name="out" value="" type="output-file" description="output file" required="true" advanced="false" supported_formats="*.consensusXML" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
14 <ITEM name="algorithm_type" value="robust_regression" type="string" description="The normalization algorithm that is applied. &apos;robust_regression&apos; scales each map by a fator computed from the ratios of non-differential background features (as determined by the ratio_threshold parameter), &apos;quantile&apos; performs quantile normalization, &apos;median&apos; scales all maps to the same median intensity, &apos;median_shift&apos; shifts the median instead of scaling (WARNING: if you have regular, log-normal MS data, &apos;median_shift&apos; is probably the wrong choice. Use only if you know what you&apos;re doing!)" required="false" advanced="false" restrictions="robust_regression,median,median_shift,quantile" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
15 <ITEM name="ratio_threshold" value="0.67" type="double" description="Only for &apos;robust_regression&apos;: the parameter is used to distinguish between non-outliers (ratio_threshold &lt; intensity ratio &lt; 1/ratio_threshold) and outliers." required="false" advanced="false" restrictions="1.0e-03:1.0" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
16 <ITEM name="accession_filter" value="" type="string" description="Use only features with accessions (partially) matching this regular expression for computing the normalization factors. Useful, e.g., if you have known house keeping proteins in your samples. When this parameter is empty or the regular expression matches the empty string, all features are used (even those without an ID). No effect if quantile normalization is used." required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
17 <ITEM name="description_filter" value="" type="string" description="Use only features with description (partially) matching this regular expression for computing the normalization factors. Useful, e.g., if you have known house keeping proteins in your samples. When this parameter is empty or the regular expression matches the empty string, all features are used (even those without an ID). No effect if quantile normalization is used." required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
18 <ITEM name="log" value="" type="string" description="Name of log file (created only when specified)" required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
19 <ITEM name="debug" value="0" type="int" description="Sets the debug level" required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
20 <ITEM name="threads" value="1" type="int" description="Sets the number of threads allowed to be used by the TOPP tool" required="false" advanced="false" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
21 <ITEM name="no_progress" value="false" type="bool" description="Disables progress logging to command line" required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
22 <ITEM name="force" value="false" type="bool" description="Overrides tool-specific checks" required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
23 <ITEM name="test" value="false" type="bool" description="Enables the test mode (needed for internal use only)" required="false" advanced="true" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
24 </NODE>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
25 </NODE>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
26 </PARAMETERS>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
27 </tool>