annotate SetReferences.xml @ 2:b2c2b2b7349f draft default tip

planemo upload for repository https://forge.inrae.fr/metexplore/met4j-galaxy commit 71335d4a636672d264cc4f443c07856907571928

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<tool id="met4j_SetReferences" name="SetReferences" version="@TOOL_VERSION@">
  <description>Add references to network objects in a SBML file from a tabulated file containing the metabolite ids and the references</description>
  <macros>
    <import>macros.xml</import>
  </macros>
  <expand macro="bio_tools"/>
  <expand macro="requirements"/>
  <command detect_errors="exit_code"><![CDATA[met4j attributes.SetReferences#if str($colRef) != 'nan':
 -cr "$colRef"
#end if
 -ref "$ref"
#if str($colid):
 -ci "$colid"
#end if
 $p
 $s
#if str($o):
 -t "$o"
#end if
#if str($nSkip):
 -n "$nSkip"
#end if
 -i "$sbml"
#if str($tab) != 'None':
 -tab "$tab"
#end if
#if str($c):
 -c "$c"
#end if
 -o "$out"
]]></command>
  <inputs>
    <param argument="-cr" label="[2] number of the column where are the references" name="colRef" optional="true" type="integer" value="2"/>
    <param argument="-ref" label="Name of the reference. Must exist in identifiers.org (https://registry.identifiers.org/registry)" name="ref" optional="false" type="text" value="">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-ci" label="[1] number of the column where are the object ids" name="colid" optional="true" type="text" value="1">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-p" checked="false" falsevalue="" label="[deactivated] To match the objects in the sbml file, adds the prefix R_ to reactions and M_ to metabolites" name="p" truevalue="-p" type="boolean" value="false"/>
    <param argument="-s" checked="false" falsevalue="" label="[deactivated] To match the objects in the sbml file, adds the suffix _comparmentID to metabolites" name="s" truevalue="-s" type="boolean" value="false"/>
    <param argument="-t" label="[REACTION] Object type in the column id : REACTION;METABOLITE;GENE;PATHWAY" name="o" optional="true" type="text" value="REACTION">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-n" label="[0] Number of lines to skip at the beginning of the tabulated file" name="nSkip" optional="true" type="text" value="0">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-i" format="sbml" label="Original SBML file" name="sbml" optional="false" type="data" value=""/>
    <param argument="-tab" format="tsv" label="Input Tabulated file" name="tab" optional="true" type="data" value=""/>
    <param argument="-c" label="[#] Comment String in the tabulated file. The lines beginning by this string won't be read" name="c" optional="true" type="text" value="#">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
  </inputs>
  <outputs>
    <data format="sbml" name="out"/>
  </outputs>
  <tests>
    <test>
      <param name="sbml" value="toy_model.xml"/>
      <param name="tab" value="refs.tsv"/>
      <param name="ref" value="InChi"/>
      <param name="o" value="METABOLITE"/>
      <output ftype="sbml" name="out">
        <assert_contents>
          <is_valid_xml/>
          <has_line_matching expression=".*C2H6O.*" n="3"/>
          <has_line_matching expression=".*C6H8O6.*" n="1"/>
        </assert_contents>
      </output>
    </test>
  </tests>
  <help><![CDATA[Add references to network objects in a SBML file from a tabulated file containing the metabolite ids and the references
Reference name given as parameter (-ref) must correspond to an existing id in the registry of identifiers.org (https://registry.identifiers.org/registry)
The corresponding key:value pair will be written as metabolite or reaction MIRIAM annotation (see https://pubmed.ncbi.nlm.nih.gov/16333295/)
@ATTRIBUTION@]]></help>
  <citations>
    <citation type="doi">10.1038/nbt1156</citation>
  </citations>
</tool>