annotate BlastParser_and_hits.xml @ 16:75dbe4f77699 draft default tip

planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
author drosofff
date Wed, 09 Nov 2016 11:32:52 -0500
parents 3bfdbfef5881
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
b1e17110a21a planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 13
diff changeset
1 <tool id="BlastParser_and_hits" name="Parse blast output and compile hits" version="2.4.3">
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
2 <description>for virus discovery</description>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
3 <requirements></requirements>
16
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
4 <command><![CDATA[
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
5 python '$__tool_directory__'/BlastParser_and_hits.py
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
6 --sequences '$sequences'
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
7 --blast '$blast'
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
8 --tabularOutput '$tabularOutput'
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
9 --fastaOutput '$fastaOutput'
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
10 --flanking $flanking
2
e0985bad7b92 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
11 --mode $mode
4
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
12 ## Additional parameters.
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
13 #if $additional_filters.use_filters == "yes":
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
14 --filter_relativeCov $additional_filters.filter_relativeCov
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
15 --filter_maxScore $additional_filters.filter_maxScore
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
16 --filter_meanScore $additional_filters.filter_meanScore
9
86f424753b2d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 8
diff changeset
17 --filter_term_in "$additional_filters.filter_term_in"
86f424753b2d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 8
diff changeset
18 --filter_term_out "$additional_filters.filter_term_out"
4
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
19 #end if
16
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
20 --al_sequences '$al_sequences'
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
21 --un_sequences '$un_sequences'
13
74d1dd5d6bbe planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 1a0169b4691ae3d693826ba4b0bab190c7b1c5e3
drosofff
parents: 12
diff changeset
22 --dataset_name "$blast.element_identifier"
4
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
23
16
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
24 ]]></command>
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
25 <inputs>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
26 <param name="sequences" type="data" format="fasta" label="fasta sequences that have been blasted" />
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
27 <param name="blast" type="data" format="tabular" label="The blast output you wish to parse" />
16
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
28 <param name="flanking" type="integer" value= "5" label="Number of flanking nucleotides to add to hits for CAP3 assembly"/>
8
efb051ac0da9 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 3d9ddd0f6f3c3b97a3bebf52646731ad6771e178
drosofff
parents: 7
diff changeset
29 <param name="mode" type="select" label="Extensive or compact reporting mode" help="display (extensive) or not (compact) the oases contigs">
16
75dbe4f77699 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit b6de14061c479f0418cd89e26d6f5ac26e565a07
drosofff
parents: 15
diff changeset
30 <option value="verbose" selected="true">extensive</option>
8
efb051ac0da9 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 3d9ddd0f6f3c3b97a3bebf52646731ad6771e178
drosofff
parents: 7
diff changeset
31 <option value="short">compact</option>
2
e0985bad7b92 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
32 </param>
4
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
33 <conditional name="additional_filters">
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
34 <param name="use_filters" type="select" label="Use Additional Filters?">
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
35 <option value="no">No</option>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
36 <option value="yes">Yes</option>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
37 </param>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
38 <when value="no">
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
39 </when>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
40 <when value="yes">
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
41 <param name="filter_relativeCov" type="float" value="0" max="1" label="Minimum Relative Subject Coverage" help=""/>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
42 <param name="filter_maxScore" type="float" value="0" label="Minimum maximum BitScore" help=""/>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
43 <param name="filter_meanScore" type="float" value="0" label="Minimum mean BitScore" help=""/>
9
86f424753b2d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 8
diff changeset
44 <param name="filter_term_in" type="text" value="" label="filter the subject list with a keyword" help=""/>
86f424753b2d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 8
diff changeset
45 <param name="filter_term_out" type="text" value="" label="filter the subject list excluding a keyword" help=""/>
4
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
46 </when>
22641bb68b91 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 2
diff changeset
47 </conditional>
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
48 </inputs>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
49 <outputs>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
50 <data name="tabularOutput" format="tabular" label="blast analysis, by subjects"/>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
51 <data name="fastaOutput" format="fasta" label="hits"/>
6
3f7cfa1cf90c planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit e511de70e387d5033ab91f37c8ddb5665fa61a87
drosofff
parents: 5
diff changeset
52 <data name="al_sequences" format="fasta" label="Blast aligned sequences"/>
3f7cfa1cf90c planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit e511de70e387d5033ab91f37c8ddb5665fa61a87
drosofff
parents: 5
diff changeset
53 <data name="un_sequences" format="fasta" label="Blast unaligned sequences"/>
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
54 </outputs>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
55
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
56 <tests>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
57 <test>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
58 <param ftype="fasta" name="sequences" value="input.fa" />
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
59 <param ftype="tabular" name="blast" value="blast.tab" />
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
60 <param name="flanking" value="5" />
5
a941981a298c planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 4
diff changeset
61 <param name="use_filters" value="no" />
2
e0985bad7b92 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
62 <param name="mode" value="verbose" />
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
63 <output name="tabularOutput" ftype="tabular" file="output.tab" />
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
64 <output name="fastaOutput" ftype="fasta" file="output.fa" />
6
3f7cfa1cf90c planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit e511de70e387d5033ab91f37c8ddb5665fa61a87
drosofff
parents: 5
diff changeset
65 <output name="al_sequences" ftype="fasta" file="al_sequences.fa" />
3f7cfa1cf90c planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit e511de70e387d5033ab91f37c8ddb5665fa61a87
drosofff
parents: 5
diff changeset
66 <output name="un_sequences" ftype="fasta" file="un_sequences.fa" />
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
67 </test>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
68 </tests>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
69
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
70 <help>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
71
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
72 **What it does**
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
73
15
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
74 Parse blast output for viruses genome assembly.
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
75
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
76 Takes as inputs
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
77
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
78 - 1. the fasta sequences that have been submitted to blast
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
79 - 2. a blast alignment in a tabular format. **Importantly** this tabular output must contains the 12 standard columns (see blast documentation), **plus a column 13** that will report the length of the subject sequence (slen). When you use blast tools prior using this tool, remember to **check the appropriate box** to get the 13th column in the blast tabular output.
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
80 - 3. the numbers of flanking nucleotides to be recovered at the ends of blast hit sequences
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
81
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
82 The tool returns 4 datasets
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
83
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
84 - 1. the fasta input sequences that produced significant blast hits
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
85 - 2. the fasta sequences that did not produced significant blast hits
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
86 - 3. the sequences of the blast hits, plus the flanking sequences (as specified in the tool form). This dataset may be further used in metavisitor workflows to produce contigs of hits.
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
87 - 4. and the parsing of the blast alignments which summarizes the blast results by "subject" sequences (blast analysis, by subjects)
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
88
3bfdbfef5881 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 14
diff changeset
89 This latter parsing dataset may be customized by tuning the reporting mode and/or using filters
0
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
90
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
91 </help>
3959a271cf3f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
92 </tool>