annotate chromeister/chromeister.xml @ 3:0589a1c5f33a draft default tip

Fixed absolute paths

<tool id="chromeister" name="Chromeister">
   <description>A heuristic approach for ultra fast previsualization of pairwise genome comparisons</description>
   <inputs>
      <param name="query" type="data" format="fasta" label="Query sequence" help="Query sequence file in fasta format" />
      <param name="db" type="data" format="fasta" label="Reference sequence" help="Reference sequence file in fasta format" />
      <param name="dimension" type="integer" value="1000" label="Dimension" help="Compression size" />
      <param name="kmer" type="integer" value="32" label="Kmer" help="Seed size used to find unique hits" />
      <param name="diffuse" type="integer" value="4" label="Difusse value" help="Level of the heuristic subsampling employed" />
   </inputs>
   <command>make all -C ${__tool_directory__}/src ; cp $query "${query.name}"; cp $db "${db.name}"; (${__tool_directory__}/bin/CHROMEISTER -query "${query.name}" -db "${db.name}" -dimension $dimension -kmer $kmer -diffuse $diffuse -out "${query.name}"-"${db.name}".mat) &amp;>/dev/null ; rm "${query.name}"; rm "${db.name}"; Rscript ${__tool_directory__}/bin/compute_score.R  "${query.name}"-"${db.name}".mat $dimension; mv "${query.name}"-"${db.name}".mat $output; mv "${query.name}"-"${db.name}".mat.filt.png $outputIMAGEN ; mv "${query.name}"-"${db.name}".mat.events.txt $outputEVENTS; rm hits-XY-"${query.name}"-"${db.name}".mat.hits</command>
  <outputs>
      <data name="output" format="txt" label="Comparison matrix"/>
      <data name="outputIMAGEN" format="png" label="Comparison dotplot"/>
      <data name="outputEVENTS" format="txt" label="Detected events"/>
  </outputs>

  <help>

Chromeister is a heuristic approach for the ultra fast previsualization of pairwise genome comparisons. It is able to compare enormous genomes (up to 30 thousand million base pairs, or 10 times the size of the human genome) much faster than other methods while yielding significant, reusable and exploitable information such as synteny blocks, evolutionary events or pairwise genome similarity metrics.

-----

**Manual**

To use Chromeister, upload two .fasta files and select these as Sequence X and as Sequence Y. Once so, choose the parameters that best suit your comparison:

- Dimension: This parameter corresponds to the resolution of the comparison. That is, higher resolution is recommended for large genomes (e.g. use 2000 for more than 3 GBps) and lower resolutions should be used for comparisons involving chromosomes or partial genomes.
- Kmer size: This parameter is the seed size used to find unique hits. The recommended value is 32 for all sequences except for small experiments such as bacterial.
- Diffuse value: This parameter determines the level of  heuristic subsampling employed. A level of 1 will use perfect indexing (no subsampling). Recommended level is 4, which represents a good trade-off between exact and inexact hits.

  </help>

  <citations>
  </citations>
</tool>