annotate mapsembler2.xml @ 0:f905f982ee3d

Imported from capsule None
author cmonjeau
date Fri, 05 Jun 2015 11:40:49 -0400
parents
children 5aea5b993ae8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
1 <tool id="mapsembler2" name="Mapsembler2" version="2.2.3">
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
2 <description>is a targeted assembly software.</description>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
3 <requirements>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
4 <requirement type="package" version="2.2.3">mapsembler2</requirement>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
5 </requirements>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
6 <command interpreter="python">
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
7 mapsembler2.py
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
8 -s $input_starters
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
9 -r $data_files
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
10 -t $output_extension
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
11 -k $kmer
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
12 -c $coverage
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
13 -d $substitutions
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
14 -g $genome_size
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
15 -f $process_search
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
16 -x $max_length
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
17 -y $max_depth
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
18 --output $output
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
19 -i $index_files
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
20 </command>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
21
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
22 <inputs>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
23 <!-- Input data files -->
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
24 <param name="input_starters" type="data" format="fasta" label="Starters" help="set of input sequences" />
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
25 <param name="data_files" type="data" multiple="true" format="fasta,fastq" label="Read file" help="Data loaded in the script" />
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
26 <param name="output_extension" type="select" label="Select your output extension type">
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
27 <option value="1">a strict sequence</option>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
28 <option value="2">a consensus sequence</option>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
29 <option value="3">a strict graph</option>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
30 <option value="4">a consensus graph</option>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
31 </param>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
32 <param name="kmer" type="integer" label="Size of kmers" value="31" help="Set the length of used kmers. Must fit the compiled value. Only uneven number" />
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
33 <param name="coverage" type="integer" label="Minimal coverage" value="5" help="set the minimal coverage: Used by Phaser (don't use kmers with lower coverage) "/>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
34 <param name="substitutions" type="integer" label="Number of authorized substitutions" value="1" help="set the number of authorized substitutions used while mapping reads on finding SNPs"/>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
35 <param name="genome_size" type="integer" label="Estimated genome size" value="10000000" help="Used only to control memory usage. e.g.3 billion (3000000000) uses 4Gb of RAM." />
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
36 <param name="process_search" type="select" label="Process of search" help="Set the process of search in the graph" >
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
37 <option value="1">Breadth</option>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
38 <option value="2">Depth</option>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
39 </param>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
40 <param name="max_length" type="integer" label="Max length of nodes" value="40" help="set the maximal length of nodes"/>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
41 <param name="max_depth" type="integer" label="Max depth of nodes" value="10000" help="set the maximal depth of the graph"/>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
42 <param name="index_files" type="boolean" checked="false" default="false" label="Include index output files" />
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
43 </inputs>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
44
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
45 <outputs>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
46 <data format="txt" name="output" label="${tool.name} on ${on_string}: out.txt" >
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
47 <discover_datasets pattern="__designation_and_ext__" directory="job_outputs" visible="true" />
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
48 </data>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
49
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
50 </outputs>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
51 <help>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
52
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
53 **Description**
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
54
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
55 Mapsembler2 is a targeted assembly software. It takes as input a set of NGS raw reads (fasta or fastq, gzipped or not) and a set of input sequences (starters). It first determines if each starter is read-coherent, e.g. whether reads confirm the presence of each starter in the original sequence. Then for each read-coherent starter, Mapsembler2 outputs its sequence neighborhood as a linear sequence or as a graph, depending on the user choice.
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
56 Mapsembler2 may be used for (not limited to):
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
57
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
58 · Validate an assembled sequence (input as starter), e.g. from a de Bruijn graph assembly where read-coherence was not enforced.
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
59
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
60 · Checks if a gene (input as starter) has an homolog in a set of reads.
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
61
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
62 · Checks if a known enzyme is present in a metagenomic NGS read set.
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
63
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
64 · Enrich unmappable reads by extending them, possibly making them mappable.
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
65
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
66 · Checks what happens at the extremities of a contig.
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
67
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
68 · Remove contaminants or symbiont reads from a read set
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
69
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
70 -------
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
71
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
72 **Web site**
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
73
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
74 http://colibread.inria.fr/mapsembler2/
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
75
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
76 -------
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
77
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
78 **Integrated by**
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
79
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
80 Cyril Monjeaud
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
81
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
82 GenOuest Bio-informatics Core Facility
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
83
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
84 UMR 6074 IRISA INRIA-CNRS-UR1 Rennes (France)
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
85
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
86 support@genouest.org
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
87
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
88 If you use this tool in Galaxy, please cite :
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
89
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
90 `Y. Le Bras, A. Roult, C. Monjeaud, M. Bahin, O. Quenez, C. Heriveau, A. Bretaudeau, O. Sallou, O. Collin, Towards a Life Sciences Virtual Research Environment : an e-Science initiative in Western France. JOBIM 2013. &lt;https://www.e-biogenouest.org/resources/128&gt;`_
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
91
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
92 </help>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
93 <citations>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
94 <citation type="doi">10.1186/1471-2105-13-48</citation>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
95 <citation type="bibtex">@INPROCEEDINGS{JOBIM2013,
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
96 author = {Le Bras, Y. and ROULT, A. and Monjeaud, C. and Bahin, M. and Quenez, O. and Heriveau, C. and Bretaudeau, A. and Sallou, O. and Collin, O.},
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
97 title = {Towards a Life Sciences Virtual Research Environment: An e-Science initiative in Western France},
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
98 booktitle = {JOBIM 2013 Proceedings},
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
99 year = {2013},
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
100 url = {https://www.e-biogenouest.org/resources/128},
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
101 pages = {97-106}
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
102 }
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
103 </citation>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
104
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
105 </citations>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
106
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
107 </tool>
f905f982ee3d Imported from capsule None
cmonjeau
parents:
diff changeset
108