annotate OpenSwathDecoyGenerator.xml @ 0:d38ef9cbc114 draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8

<?xml version='1.0' encoding='UTF-8'?>
<!--This is a configuration file for the integration of a tools into Galaxy (https://galaxyproject.org/). This file was automatically generated using CTD2Galaxy.-->
<!--Proposed Tool Section: [Targeted Experiments]-->
<tool id="OpenSwathDecoyGenerator" name="OpenSwathDecoyGenerator" version="2.1.0">
  <description>Generates decoys according to different models for a specific TraML</description>
  <macros>
    <token name="@EXECUTABLE@">OpenSwathDecoyGenerator</token>
    <import>macros.xml</import>
  </macros>
  <expand macro="references"/>
  <expand macro="stdio"/>
  <expand macro="requirements"/>
  <command>OpenSwathDecoyGenerator

#if $param_in:
  -in $param_in
#end if
#if $param_out:
  -out $param_out
#end if
#if $param_method:
  -method     "$param_method"
#end if
#if $param_decoy_tag:
  -decoy_tag     "$param_decoy_tag"
#end if
#if $param_mz_threshold:
  -mz_threshold $param_mz_threshold
#end if
#if $param_exclude_similar:
  -exclude_similar
#end if
#if $param_similarity_threshold:
  -similarity_threshold $param_similarity_threshold
#end if
#if $param_append:
  -append
#end if
#if $param_remove_CNterm_mods:
  -remove_CNterm_mods
#end if
#if $param_remove_unannotated:
  -remove_unannotated
#end if
#if $param_identity_threshold:
  -identity_threshold $param_identity_threshold
#end if
#if $param_max_attempts:
  -max_attempts $param_max_attempts
#end if
#if $param_mz_shift:
  -mz_shift $param_mz_shift
#end if
#if $param_precursor_mass_shift:
  -precursor_mass_shift $param_precursor_mass_shift
#end if
#if $param_allowed_fragment_types:
  -allowed_fragment_types     "$param_allowed_fragment_types"
#end if
#if $param_allowed_fragment_charges:
  -allowed_fragment_charges     "$param_allowed_fragment_charges"
#end if
#if $param_enable_detection_specific_losses:
  -enable_detection_specific_losses
#end if
#if $param_enable_detection_unspecific_losses:
  -enable_detection_unspecific_losses
#end if
#if $adv_opts.adv_opts_selector=='advanced':
    #if $adv_opts.param_force:
  -force
#end if
#end if
</command>
  <inputs>
    <param name="param_in" type="data" format="traml" optional="False" label="input file ('traML')" help="(-in) "/>
    <param name="param_method" type="text" size="30" value="shuffle" label="decoy generation method ('shuffle','pseudo-reverse','reverse','shift')" help="(-method) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </param>
    <param name="param_decoy_tag" type="text" size="30" value="DECOY_" label="decoy tag" help="(-decoy_tag) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </param>
    <param name="param_mz_threshold" type="float" value="0.05" label="MZ threshold in Thomson for fragment ion annotation" help="(-mz_threshold) "/>
    <param name="param_exclude_similar" display="radio" type="boolean" truevalue="-exclude_similar" falsevalue="" checked="false" optional="True" label="set this flag if decoy assays with similarity of the peptide sequence to the target assays higher than the identity_threshold should be excluded" help="(-exclude_similar) If similarity_threshold is over 0, decoy assays with an absolute difference of the decoy and target product mz smaller than similarity_threshold are further excluded"/>
    <param name="param_similarity_threshold" type="float" value="-1.0" label="Similarity threshold for absolute difference of the product mz of target and decoy assays for exclusion in Dalton" help="(-similarity_threshold) Suggested value: 0.05"/>
    <param name="param_append" display="radio" type="boolean" truevalue="-append" falsevalue="" checked="false" optional="True" label="set this flag if non-decoy TraML should be appended to the output" help="(-append) "/>
    <param name="param_remove_CNterm_mods" display="radio" type="boolean" truevalue="-remove_CNterm_mods" falsevalue="" checked="false" optional="True" label="set this flag to remove decoy peptides with C/N terminal modifications (may be necessary depending on the decoy generation method)" help="(-remove_CNterm_mods) "/>
    <param name="param_remove_unannotated" display="radio" type="boolean" truevalue="-remove_unannotated" falsevalue="" checked="false" optional="True" label="set this flag if target assays with unannotated ions should be ignored from decoy generation" help="(-remove_unannotated) "/>
    <param name="param_identity_threshold" type="float" value="0.7" label="shuffle: identity threshold for the shuffle algorithm" help="(-identity_threshold) "/>
    <param name="param_max_attempts" type="integer" value="10" label="shuffle: maximum attempts to lower the sequence identity between target and decoy for the shuffle algorithm" help="(-max_attempts) "/>
    <param name="param_mz_shift" type="float" value="20.0" label="shift: MZ shift in Thomson for shift decoy method" help="(-mz_shift) "/>
    <param name="param_precursor_mass_shift" type="float" value="0.0" label="Mass shift to apply to the precursor ion" help="(-precursor_mass_shift) "/>
    <param name="param_allowed_fragment_types" type="text" size="30" value="b,y" label="allowed fragment types" help="(-allowed_fragment_types) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </param>
    <param name="param_allowed_fragment_charges" type="text" size="30" value="1,2,3,4" label="allowed fragment charge states" help="(-allowed_fragment_charges) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </param>
    <param name="param_enable_detection_specific_losses" display="radio" type="boolean" truevalue="-enable_detection_specific_losses" falsevalue="" checked="false" optional="True" label="set this flag if specific neutral losses for detection fragment ions should be allowed" help="(-enable_detection_specific_losses) "/>
    <param name="param_enable_detection_unspecific_losses" display="radio" type="boolean" truevalue="-enable_detection_unspecific_losses" falsevalue="" checked="false" optional="True" label="set this flag if unspecific neutral losses (H2O1, H3N1, C1H2N2, C1H2N1O1) for detection fragment ions should be allowed" help="(-enable_detection_unspecific_losses) "/>
    <expand macro="advanced_options">
      <param name="param_force" display="radio" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
    </expand>
  </inputs>
  <outputs>
    <data name="param_out" format="traml"/>
  </outputs>
  <help>Generates decoys according to different models for a specific TraML


For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_OpenSwathDecoyGenerator.html</help>
</tool>