annotate tools/networkAnalysis/DistanceMatrix/DistanceMatrix.xml @ 0:3cdcfdae8bd2 draft default tip

"planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit a58b6f8a6dde6ef64da64ee50395dc5bc848167a-dirty"

<?xml version="1.0" encoding="UTF-8"?>
<tool id="met4j_DistanceMatrix" name="DistanceMatrix" version="0.11.0">
  <description>Create a compound to compound distance matrix.</description>
  <xrefs>
    <xref type="bio.tools">met4j</xref>
  </xrefs>
  <requirements>
    <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:0.11.0</container>
  </requirements>
  <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.DistanceMatrix -i "$inputPath"
#if str($sideCompoundFile) != 'None':
 -s "$sideCompoundFile"
#end if
 $degree
#if str($weightFile) != 'None':
 -w "$weightFile"
#end if
 $undirected
 -o "$outputPath"
]]></command>
  <inputs>
    <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
    <param argument="-s" format="text" label="an optional file containing list of side compounds to ignore" name="sideCompoundFile" optional="true" type="data" value=""/>
    <param argument="-dw" checked="false" falsevalue="" label="penalize traversal of hubs by using degree square weighting (-w must not be set)" name="degree" truevalue="-dw" type="boolean" value="false"/>
    <param argument="-w" format="tsv" label="an optional file containing weights for compound pairs" name="weightFile" optional="true" type="data" value=""/>
    <param argument="-u" checked="false" falsevalue="" label="Ignore reaction direction" name="undirected" truevalue="-u" type="boolean" value="false"/>
  </inputs>
  <outputs>
    <data format="csv" name="outputPath"/>
  </outputs>
  <tests>
    <test>
      <param name="inputPath" value="toy_model.xml"/>
      <output ftype="csv" name="outputPath">
        <assert_contents>
          <has_n_lines n="9"/>
          <has_line_matching expression="B,1.0,0.0,Infinity,2.0,1.0,Infinity,2.0,Infinity" n="1"/>
        </assert_contents>
      </output>
    </test>
    <test>
      <param name="inputPath" value="toy_model.xml"/>
      <param name="sideCompoundFile" value="sides.txt"/>
      <param name="degree" value="true"/>
      <param name="undirected" value="true"/>
      <output ftype="csv" name="outputPath">
        <assert_contents>
          <has_n_lines n="8"/>
          <has_line_matching expression="B,9.0,0.0,13.0,16.0,32.0,17.0,36.0" n="1"/>
        </assert_contents>
      </output>
    </test>
  </tests>
  <help><![CDATA[Create a compound to compound distance matrix.
The distance between two compounds is computed as the length of the shortest path connecting the two in the compound graph, where two compounds are linked if they are respectively substrate and product of the same reaction.
An optional edge weighting can be used, turning the distances into the sum of edge weights in the lightest path, rather than the length of the shortest path.The default weighting use target's degree squared. Alternatively, custom weighting can be provided in a file. In that case, edges without weight are ignored during path search.
If no edge weighting is set, it is recommended to provide a list of side compounds to ignore during network traversal.]]></help>
</tool>