annotate MetaProSIP.xml @ 9:73c1493ac4c2 draft

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

<?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 CTDConverter.-->
<!--Proposed Tool Section: [Utilities]-->
<tool id="MetaProSIP" name="MetaProSIP" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
  <description>Performs proteinSIP on peptide features for elemental flux analysis.</description>
  <macros>
    <token name="@EXECUTABLE@">MetaProSIP</token>
    <import>macros.xml</import>
    <import>macros_autotest.xml</import>
    <import>macros_test.xml</import>
  </macros>
  <expand macro="requirements"/>
  <expand macro="stdio"/>
  <command detect_errors="exit_code"><![CDATA[@QUOTE_FOO@
@EXT_FOO@
#import re

## Preprocessing
mkdir in_mzML &&
ln -s '$in_mzML' 'in_mzML/${re.sub("[^\w\-_]", "_", $in_mzML.element_identifier)}.$gxy2omsext($in_mzML.ext)' &&
mkdir in_fasta &&
ln -s '$in_fasta' 'in_fasta/${re.sub("[^\w\-_]", "_", $in_fasta.element_identifier)}.$gxy2omsext($in_fasta.ext)' &&
mkdir out_csv &&
mkdir out_peptide_centric_csv &&
mkdir in_featureXML &&
ln -s '$in_featureXML' 'in_featureXML/${re.sub("[^\w\-_]", "_", $in_featureXML.element_identifier)}.$gxy2omsext($in_featureXML.ext)' &&

## Main program call

set -o pipefail &&
@EXECUTABLE@ -write_ctd ./ &&
python3 '$__tool_directory__/fill_ctd.py' '@EXECUTABLE@.ctd' '$args_json' '$hardcoded_json' &&
@EXECUTABLE@ -ini @EXECUTABLE@.ctd
-in_mzML
'in_mzML/${re.sub("[^\w\-_]", "_", $in_mzML.element_identifier)}.$gxy2omsext($in_mzML.ext)'
-in_fasta
'in_fasta/${re.sub("[^\w\-_]", "_", $in_fasta.element_identifier)}.$gxy2omsext($in_fasta.ext)'
-out_csv
'out_csv/output.${gxy2omsext("csv")}'
-out_peptide_centric_csv
'out_peptide_centric_csv/output.${gxy2omsext("csv")}'
-in_featureXML
'in_featureXML/${re.sub("[^\w\-_]", "_", $in_featureXML.element_identifier)}.$gxy2omsext($in_featureXML.ext)'

## Postprocessing
&& mv 'out_csv/output.${gxy2omsext("csv")}' '$out_csv'
&& mv 'out_peptide_centric_csv/output.${gxy2omsext("csv")}' '$out_peptide_centric_csv'
#if "ctd_out_FLAG" in $OPTIONAL_OUTPUTS
  && mv '@EXECUTABLE@.ctd' '$ctd_out'
#end if]]></command>
  <configfiles>
    <inputs name="args_json" data_style="paths"/>
    <configfile name="hardcoded_json"><![CDATA[{"r_executable": "R", "log": "log.txt", "threads": "\${GALAXY_SLOTS:-1}", "no_progress": true}]]></configfile>
  </configfiles>
  <inputs>
    <param name="in_mzML" argument="-in_mzML" type="data" format="mzml" optional="false" label="Centroided MS1 data" help=" select mzml data sets(s)"/>
    <param name="in_fasta" argument="-in_fasta" type="data" format="fasta" optional="false" label="Protein sequence database" help=" select fasta data sets(s)"/>
    <param name="in_featureXML" argument="-in_featureXML" type="data" format="featurexml" optional="false" label="Feature data annotated with identifications (IDMapper)" help=" select featurexml data sets(s)"/>
    <param name="mz_tolerance_ppm" argument="-mz_tolerance_ppm" type="float" optional="true" value="10.0" label="Tolerance in ppm" help=""/>
    <param name="rt_tolerance_s" argument="-rt_tolerance_s" type="float" optional="true" value="30.0" label="Rolerance window around feature rt for XIC extraction" help=""/>
    <param name="intensity_threshold" argument="-intensity_threshold" type="float" optional="true" value="10.0" label="Intensity threshold to collect peaks in the MS1 spectrum" help=""/>
    <param name="correlation_threshold" argument="-correlation_threshold" type="float" optional="true" value="0.7" label="Correlation threshold for reporting a RIA" help=""/>
    <param name="xic_threshold" argument="-xic_threshold" type="float" optional="true" value="0.7" label="Minimum correlation to mono-isotopic peak for retaining a higher isotopic peak" help="If featureXML from reference file is used it should be disabled (set to -1) as no mono-isotopic peak is expected to be present"/>
    <param name="decomposition_threshold" argument="-decomposition_threshold" type="float" optional="true" value="0.7" label="Minimum R-squared of decomposition that must be achieved for a peptide to be reported" help=""/>
    <param name="weight_merge_window" argument="-weight_merge_window" type="float" optional="true" value="5.0" label="Decomposition coefficients within +- this rate window will be combined" help=""/>
    <param name="plot_extension" argument="-plot_extension" display="radio" type="select" optional="false" label="Extension used for plots (png|svg|pdf)" help="">
      <option value="png" selected="true">png</option>
      <option value="svg">svg</option>
      <option value="pdf">pdf</option>
      <expand macro="list_string_san"/>
    </param>
    <param name="qc_output_directory" argument="-qc_output_directory" type="text" optional="true" value="" label="Output directory for the quality report" help="">
      <expand macro="list_string_san"/>
    </param>
    <param name="labeling_element" argument="-labeling_element" display="radio" type="select" optional="false" label="Which element (single letter code) is labeled" help="">
      <option value="C" selected="true">C</option>
      <option value="N">N</option>
      <option value="H">H</option>
      <option value="O">O</option>
      <expand macro="list_string_san"/>
    </param>
    <param name="use_unassigned_ids" argument="-use_unassigned_ids" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Include identifications not assigned to a feature in pattern detection" help=""/>
    <param name="use_averagine_ids" argument="-use_averagine_ids" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Use averagine peptides as model to perform pattern detection on unidentified peptides" help=""/>
    <param name="report_natural_peptides" argument="-report_natural_peptides" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Whether purely natural peptides are reported in the quality report" help=""/>
    <param name="filter_monoisotopic" argument="-filter_monoisotopic" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Try to filter out mono-isotopic patterns to improve detection of low RIA patterns" help=""/>
    <param name="cluster" argument="-cluster" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Perform grouping" help=""/>
    <expand macro="adv_opts_macro">
      <param name="min_correlation_distance_to_averagine" argument="-min_correlation_distance_to_averagine" type="float" optional="true" value="-1.0" label="Minimum difference in correlation between incorporation pattern and averagine pattern" help="Positive values filter all RIAs passing the correlation threshold but that also show a better correlation to an averagine peptide. Disabled for values &lt;= -1"/>
      <param name="pattern_15N_TIC_threshold" argument="-pattern_15N_TIC_threshold" type="float" optional="true" value="0.95" label="The most intense peaks of the theoretical pattern contributing to at least this TIC fraction are taken into account" help=""/>
      <param name="pattern_13C_TIC_threshold" argument="-pattern_13C_TIC_threshold" type="float" optional="true" value="0.95" label="The most intense peaks of the theoretical pattern contributing to at least this TIC fraction are taken into account" help=""/>
      <param name="pattern_2H_TIC_threshold" argument="-pattern_2H_TIC_threshold" type="float" optional="true" value="0.95" label="The most intense peaks of the theoretical pattern contributing to at least this TIC fraction are taken into account" help=""/>
      <param name="pattern_18O_TIC_threshold" argument="-pattern_18O_TIC_threshold" type="float" optional="true" value="0.95" label="The most intense peaks of the theoretical pattern contributing to at least this TIC fraction are taken into account" help=""/>
      <param name="heatmap_bins" argument="-heatmap_bins" type="integer" optional="true" value="20" label="Number of RIA bins for heat map generation" help=""/>
      <param name="observed_peak_fraction" argument="-observed_peak_fraction" type="float" optional="true" value="0.5" label="Fraction of observed/expected peaks" help=""/>
      <param name="min_consecutive_isotopes" argument="-min_consecutive_isotopes" type="integer" optional="true" value="2" label="Minimum number of consecutive isotopic intensities needed" help=""/>
      <param name="score_plot_yaxis_min" argument="-score_plot_yaxis_min" type="float" optional="true" value="0.0" label="The minimum value of the score axis" help="Values smaller than zero usually only make sense if the observed peak fraction is set to 0"/>
      <param name="collect_method" argument="-collect_method" display="radio" type="select" optional="false" label="How RIAs are collected" help="">
        <option value="correlation_maximum" selected="true">correlation_maximum</option>
        <option value="decomposition_maximum">decomposition_maximum</option>
        <expand macro="list_string_san"/>
      </param>
      <param name="lowRIA_correlation_threshold" argument="-lowRIA_correlation_threshold" type="float" optional="true" value="-1.0" label="Correlation threshold for reporting low RIA patterns" help="Disable and take correlation_threshold value for negative values"/>
      <param name="force" argument="-force" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Overwrite tool specific checks" help=""/>
      <param name="test" argument="-test" type="hidden" optional="true" value="False" label="Enables the test mode (needed for internal use only)" help="">
        <expand macro="list_string_san"/>
      </param>
    </expand>
    <param name="OPTIONAL_OUTPUTS" type="select" multiple="true" label="Optional outputs" optional="true">
      <option value="ctd_out_FLAG">Output used ctd (ini) configuration file</option>
    </param>
  </inputs>
  <outputs>
    <data name="out_csv" label="${tool.name} on ${on_string}: out_csv" format="csv"/>
    <data name="out_peptide_centric_csv" label="${tool.name} on ${on_string}: out_peptide_centric_csv" format="csv"/>
    <data name="ctd_out" format="xml" label="${tool.name} on ${on_string}: ctd">
      <filter>OPTIONAL_OUTPUTS is not None and "ctd_out_FLAG" in OPTIONAL_OUTPUTS</filter>
    </data>
  </outputs>
  <tests>
    <expand macro="autotest_MetaProSIP"/>
    <expand macro="manutest_MetaProSIP"/>
  </tests>
  <help><![CDATA[Performs proteinSIP on peptide features for elemental flux analysis.


For more information, visit http://www.openms.de/documentation/UTILS_MetaProSIP.html]]></help>
  <expand macro="references"/>
</tool>