annotate build/tools/CompoundNet/CompoundNet.xml @ 6:7a6f2380fc1d draft

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

<?xml version="1.0" encoding="UTF-8"?>
<tool id="met4j_CompoundNet" name="CompoundNet" version="1.3.0">
  <description>Advanced creation of a compound graph representation of a SBML file content</description>
  <xrefs>
    <xref type="bio.tools">met4j</xref>
  </xrefs>
  <requirements>
    <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:1.3.0</container>
  </requirements>
  <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.CompoundNet -s "$inputPath"
#if str($inputSide) != 'None':
 -sc "$inputSide"
#end if
#if str($mergingStrat):
 -mc "$mergingStrat"
#end if
 $mergeEdges
 $removeIsolated
 $degree
#if str($weightFile) != 'None':
 -cw "$weightFile"
#end if
 $undirected
 $computeWeight
 $asMatrix
 -o "$outputPath"
]]></command>
  <inputs>
    <param argument="-s" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
    <param argument="-sc" format="txt" label="input Side compound file" name="inputSide" optional="true" type="data" value=""/>
    <param argument="-mc" label="merge compartments. Use names if consistent and unambiguous across compartments, or identifiers if compartment suffix is present (id in form &quot;xxx_y&quot; with xxx as base identifier and y as compartment label)." name="mergingStrat" optional="true" type="select" value="no">
      <option selected="true" value="no">no</option>
      <option value="by_name">by_name</option>
      <option value="by_id">by_id</option>
    </param>
    <param argument="-me" checked="false" falsevalue="" label="merge parallel edges to produce a simple graph" name="mergeEdges" truevalue="-me" type="boolean" value="false"/>
    <param argument="-ri" checked="false" falsevalue="" label="remove isolated nodes" name="removeIsolated" truevalue="-ri" type="boolean" value="false"/>
    <param argument="-dw" checked="false" falsevalue="" label="penalize traversal of hubs by using degree square weighting" name="degree" truevalue="-dw" type="boolean" value="false"/>
    <param argument="-cw" format="tsv" label="an optional file containing weights for compound pairs" name="weightFile" optional="true" type="data" value=""/>
    <param argument="-un" checked="false" falsevalue="" label="create as undirected" name="undirected" truevalue="-un" type="boolean" value="false"/>
    <param argument="-tp" checked="false" falsevalue="" label="set weight as random walk transition probability, normalized by reaction" name="computeWeight" truevalue="-tp" type="boolean" value="false"/>
    <param argument="-am" checked="false" falsevalue="" label="export as matrix (implies simple graph conversion). Default export as GML file" name="asMatrix" truevalue="-am" type="boolean" value="false"/>
  </inputs>
  <outputs>
    <data format="gml" name="outputPath"/>
  </outputs>
  <tests>
    <test>
      <param name="inputPath" value="XF_network.sbml"/>
      <param name="inputSide" value="XF_network_C_Side.tab"/>
      <output name="outputPath">
        <assert_contents>
          <has_line_matching expression=".*node.*" n="1101"/>
          <has_line_matching expression=".*edge.*" n="5581"/>
        </assert_contents>
      </output>
    </test>
    <test>
      <param name="inputPath" value="XF_network.sbml"/>
      <param name="inputSide" value="XF_network_C_Side.tab"/>
      <param name="undirected" value="true"/>
      <param name="computeWeight" value="true"/>
      <param name="removeIsolated" value="true"/>
      <param name="degree" value="true"/>
      <param name="mergingStrat" value="by_id"/>
      <output name="outputPath">
        <assert_contents>
          <has_line_matching expression=".*node.*" n="793"/>
          <has_line_matching expression=".*edge.*" n="9372"/>
        </assert_contents>
      </output>
    </test>
  </tests>
  <help><![CDATA[Metabolic networks used for quantitative analysis often contain links that are irrelevant for graph-based structural analysis. For example, inclusion of side compounds or modelling artifacts such as 'biomass' nodes.
While Carbon Skeleton Graph offer a relevant alternative topology for graph-based analysis, it requires compounds' structure information, usually not provided in model, and difficult to retrieve for model with sparse cross-reference annotations.
In contrary to the SBML2Graph app that performs a raw conversion of the SBML content, the present app propose a fine-tuned creation of compound graph from predefined list of side compounds and degree² weighting to get relevant structure without structural data.This app also enable Markov-chain based analysis of metabolic networks by computing reaction-normalized transition probabilities on the network.]]></help>
  <citations/>
</tool>