annotate BlastParser_and_hits.xml @ 12:80e4273db58d draft

planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
author drosofff
date Tue, 05 Apr 2016 05:15:26 -0400
parents 77346ecf5a28
children b055eb08ad89
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
1 <tool id="BlastParser_and_hits" name="Parse blast output and compile hits" version="2.4.3">
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
2 <description>for virus discovery</description>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
3 <requirements></requirements>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
4 <command interpreter="python">
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
5 BlastParser_and_hits.py
11
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
6 --sequences $sequences
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
7 --blast $blast
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
8 --tabularOutput $tabularOutput
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
9 --fastaOutput $fastaOutput
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
10 --flanking $flanking
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
11 --mode $mode
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
12 ## Additional parameters.
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
13 #if $additional_filters.use_filters == "yes":
11
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
14 --filter_relativeCov $additional_filters.filter_relativeCov
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
15 --filter_maxScore $additional_filters.filter_maxScore
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
16 --filter_meanScore $additional_filters.filter_meanScore
4
60b6bd959929 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 3
diff changeset
17 --filter_term_in "$additional_filters.filter_term_in"
60b6bd959929 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 3
diff changeset
18 --filter_term_out "$additional_filters.filter_term_out"
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
19 #end if
11
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
20 --al_sequences $al_sequences
77346ecf5a28 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e979a94ca761f94e6617b3e761bde5775846d2d8
drosofff
parents: 10
diff changeset
21 --un_sequences $un_sequences
10
ddebfe3fb11a planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 1863d04c44d7bf6386624e76263ec27e61d1e632
drosofff
parents: 9
diff changeset
22 --dataset_name "$blast.element_identifier"
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
23
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
24 </command>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
25 <inputs>
69ea2a13947f 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" />
69ea2a13947f 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" />
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
28 <param name="flanking" type="text" size="5" value= "5" label="Number of flanking nucleotides to add to hits for CAP3 assembly"/>
3
8f5d48294f70 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 3d9ddd0f6f3c3b97a3bebf52646731ad6771e178
drosofff
parents: 2
diff changeset
29 <param name="mode" type="select" label="Extensive or compact reporting mode" help="display (extensive) or not (compact) the oases contigs">
8f5d48294f70 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 3d9ddd0f6f3c3b97a3bebf52646731ad6771e178
drosofff
parents: 2
diff changeset
30 <option value="verbose" default="true">extensive</option>
8f5d48294f70 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit 3d9ddd0f6f3c3b97a3bebf52646731ad6771e178
drosofff
parents: 2
diff changeset
31 <option value="short">compact</option>
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
32 </param>
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
33 <conditional name="additional_filters">
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
34 <param name="use_filters" type="select" label="Use Additional Filters?">
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
35 <option value="no">No</option>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
36 <option value="yes">Yes</option>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
37 </param>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
38 <when value="no">
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
39 </when>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
40 <when value="yes">
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
41 <param name="filter_relativeCov" type="float" value="0" max="1" label="Minimum Relative Subject Coverage" help=""/>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
42 <param name="filter_maxScore" type="float" value="0" label="Minimum maximum BitScore" help=""/>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
43 <param name="filter_meanScore" type="float" value="0" label="Minimum mean BitScore" help=""/>
4
60b6bd959929 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 3
diff changeset
44 <param name="filter_term_in" type="text" value="" label="filter the subject list with a keyword" help=""/>
60b6bd959929 planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit e842488e979d8a00b9646061573355cb427bc89c
drosofff
parents: 3
diff changeset
45 <param name="filter_term_out" type="text" value="" label="filter the subject list excluding a keyword" help=""/>
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
46 </when>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
47 </conditional>
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
48 </inputs>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
49 <outputs>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
50 <data name="tabularOutput" format="tabular" label="blast analysis, by subjects"/>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
51 <data name="fastaOutput" format="fasta" label="hits"/>
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
52 <data name="al_sequences" format="fasta" label="Blast aligned sequences"/>
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
53 <data name="un_sequences" format="fasta" label="Blast unaligned sequences"/>
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
54 </outputs>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
55
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
56 <tests>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
57 <test>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
58 <param ftype="fasta" name="sequences" value="input.fa" />
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
59 <param ftype="tabular" name="blast" value="blast.tab" />
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
60 <param name="flanking" value="5" />
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
61 <param name="use_filters" value="no" />
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
62 <param name="mode" value="verbose" />
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
63 <output name="tabularOutput" ftype="tabular" file="output.tab" />
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
64 <output name="fastaOutput" ftype="fasta" file="output.fa" />
1
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
65 <output name="al_sequences" ftype="fasta" file="al_sequences.fa" />
1964514aabde planemo upload for repository https://bitbucket.org/drosofff/gedtools/ commit 1cc2b50091f512593c502176619998f5908fc8e8
drosofff
parents: 0
diff changeset
66 <output name="un_sequences" ftype="fasta" file="un_sequences.fa" />
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
67 </test>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
68 </tests>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
69
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
70 <help>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
71
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
72 **What it does**
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
73
12
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
74 Parse blast output for viruses genome assembly.
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
75
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
76 Takes as inputs
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
77
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
78 - 1. the fasta sequences that have been submitted to blast
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
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.
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
80 - 3. the numbers of flanking nucleotides to be recovered at the ends of blast hit sequences
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
81
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
82 The tool returns 4 datasets
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
83
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
84 - 1. the fasta input sequences that produced significant blast hits
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
85 - 2. the fasta sequences that did not produced significant blast hits
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
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.
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
87 - 4. and the parsing of the blast alignments which summarizes the blast results by "subject" sequences (blast analysis, by subjects)
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
88
80e4273db58d planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/msp_blastparser_and_hits commit ef2184fc4283307b338d41a6bcaf49dc37543e43
drosofff
parents: 11
diff changeset
89 This latter parsing dataset may be customized by tuning the reporting mode and/or using filters
0
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
90
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
91 </help>
69ea2a13947f planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
92 </tool>