annotate ctd/DatabaseSuitability.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="DatabaseSuitability" docurl="" category="" >
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[Computes a suitability score for a database which was used for a peptide identification search. Also reports the quality of LC-MS spectra.]]></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[Computes a suitability score for a database which was used for a peptide identification search. Also reports the quality of LC-MS spectra.]]></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 <citation doi="10.1074/mcp.TIR119.001752" url="" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
8 </citations>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
9 <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
10 <NODE name="DatabaseSuitability" description="Computes a suitability score for a database which was used for a peptide identification search. Also reports the quality of LC-MS spectra.">
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
11 <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
12 <NODE name="1" description="Instance &apos;1&apos; section for &apos;DatabaseSuitability&apos;">
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="in_id" value="" type="input-file" description="Input idXML file from peptide search with combined database with added de novo peptide. PeptideIndexer is needed, FDR is forbidden." required="true" advanced="false" supported_formats="*.idXML" />
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="in_spec" value="" type="input-file" description="Input MzML file used for the peptide identification" required="true" advanced="false" supported_formats="*.mzML" />
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="in_novo" value="" type="input-file" description="Input idXML file containing de novo peptides (unfiltered)" required="true" advanced="false" supported_formats="*.idXML" />
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="out" value="" type="output-file" description="Optional tsv output containing database suitability information as well as spectral quality." required="false" advanced="false" supported_formats="*.tsv" />
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="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
18 <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
19 <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
20 <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
21 <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
22 <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
23 <NODE name="algorithm" description="Parameter section for the suitability calculation algorithm">
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
24 <ITEM name="no_rerank" value="false" type="bool" description="Use this flag if you want to disable re-ranking. Cases, where a de novo peptide scores just higher than the database peptide, are overlooked and counted as a de novo hit. This might underestimate the database quality." 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
25 <ITEM name="reranking_cutoff_percentile" value="0.01" type="double" description="Swap a top-scoring deNovo hit with a lower scoring DB hit if their xcorr score difference is in the given percentile of all score differences between the first two decoy hits of a PSM. The lower the value the lower the decoy cut-off will be. Therefore it will be harder for a lower scoring DB hit to be re-ranked to the top." required="false" advanced="false" restrictions="0.0:1.0" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
26 <ITEM name="FDR" value="0.01" type="double" description="Filter peptide hits based on this q-value. (e.g., 0.05 = 5 % FDR)" required="false" advanced="false" restrictions="0.0:1.0" />
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
27 </NODE>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
28 </NODE>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
29 </NODE>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
30 </PARAMETERS>
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
31 </tool>