annotate DistanceMatrix.xml @ 0:bafffac56b4f draft

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

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<tool id="met4j_DistanceMatrix" name="DistanceMatrix" version="@TOOL_VERSION@">
  <description>Create a compound to compound distance matrix.</description>
  <macros>
    <import>macros.xml</import>
  </macros>
  <expand macro="bio_tools"/>
  <expand macro="requirements"/>
  <command detect_errors="exit_code"><![CDATA[met4j fr.inrae.toulouse.metexplore.met4j_toolbox.networkAnalysis.DistanceMatrix -i "$inputPath"
#if str($sideCompoundFile) != 'None':
 -sc "$sideCompoundFile"
#end if
#if str($seedFile) != 'None':
 -s "$seedFile"
#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="-sc" format="txt" label="an optional file containing list of side compounds to ignore" name="sideCompoundFile" optional="true" type="data" value=""/>
    <param argument="-s" format="txt" label="an optional file containing list of compounds of interest. The returned distance matrix contains only the corresponding rows and columns" name="seedFile" 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="id,A,A_ext,B,C,D,D_ext,E,E_ext" n="1"/>
          <has_line_matching expression="B,1.0,Infinity,0.0,2.0,1.0,2.0,Infinity,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="id,A,B,C,D,D_ext,E,E_ext" n="1"/>
          <has_line_matching expression="A,0.0,4.0,4.0,20.0,21.0,24.0,25.0" n="1"/>
          <has_line_matching expression="B,4.0,0.0,8.0,16.0,17.0,20.0,21.0" n="1"/>
          <has_line_matching expression="C,4.0,8.0,0.0,16.0,17.0,20.0,21.0" n="1"/>
          <has_line_matching expression="D,8.0,4.0,4.0,0.0,1.0,4.0,5.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.
@ATTRIBUTION@]]></help>
  <citations/>
</tool>