annotate NameMatcher.xml @ 2:eecf4a934d32 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_NameMatcher" name="NameMatcher" version="@TOOL_VERSION@">
  <description>This tool runs edit-distance based fuzzy matching to perform near-similar name matching between a metabolic model and a list of chemical names in a dataset. A harmonization processing is performed on chemical names with substitutions of common patterns among synonyms, in order to create aliases on which classical fuzzy matching can be run efficiently.</description>
  <macros>
    <import>macros.xml</import>
  </macros>
  <expand macro="bio_tools"/>
  <expand macro="requirements"/>
  <command detect_errors="exit_code"><![CDATA[met4j mapping.NameMatcher#if str($n):
 -nMatch "$n"
#end if
#if str($nSkip):
 -skip "$nSkip"
#end if
#if str($col):
 -col "$col"
#end if
 -i "$sbml"
 -compound "$input"
#if str($comment):
 -c "$comment"
#end if
#if str($sep):
 -sep "$sep"
#end if
 -o "$outputFile"
]]></command>
  <inputs>
    <param argument="-nMatch" label="[1] Number of matchs to return per name" name="n" optional="true" type="text" value="1">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-skip" label="[0] Number of lines to skip at the beginning of the compound file" name="nSkip" optional="true" type="text" value="0">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-col" label="[1] column containing compounds' names" name="col" optional="true" type="text" value="1">
      <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="-compound" format="tsv" label="Compound file containing one column with compound names to search among the SBML entries" name="input" optional="false" type="data" value=""/>
    <param argument="-c" label="[#] Comment String in the compound file. The lines beginning by this string won't be read" name="comment" optional="true" type="text" value="#">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
    <param argument="-sep" label="[\t] separator in the compound file to split the colmumns." name="sep" optional="true" type="text" value="&#9;">
      <sanitizer invalid_char="_">
        <valid initial="string.printable"/>
      </sanitizer>
    </param>
  </inputs>
  <outputs>
    <data format="tsv" name="outputFile"/>
  </outputs>
  <tests/>
  <help><![CDATA[Metabolic models and Metabolomics Data often refer compounds only by using their common names, which vary greatly according to the source, thus impeding interoperability between models, databases and experimental data. This requires a tedious step of manual mapping. Fuzzy matching is a range of methods which can potentially helps fasten this process, by allowing the search for near-similar names. Fuzzy matching is primarily designed for common language search engines and is frequently based on edit distance, i.e. the number of edits to transform a character string into another, effectively managing typo, case and special character variations, and allowing auto-completion. However, edit-distance based search fall short when mapping chemical names: As an example, alpha-D-Glucose et Glucose would require more edits than between Fructose and Glucose.
This tool runs edit-distance based fuzzy matching to perform near-similar name matching between a metabolic model and a list of chemical names in a dataset. A harmonization processing is performed on chemical names with substitutions of common patterns among synonyms, in order to create aliases on which classical fuzzy matching can be run efficiently.
@ATTRIBUTION@]]></help>
  <citations/>
</tool>