annotate igblastn.xml @ 2:4f8a1d121384 draft

Uploaded
author davidvanzessen
date Mon, 05 Sep 2016 11:15:22 -0400
parents afe85eb6572e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
1 <tool id="igblastn" name="igBLASTn" version="0.1.0">
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
2 <description> </description>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
3 <command interpreter="bash">
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
4 igblast/igblast.sh $input $species $locus $output
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
5 </command>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
6 <inputs>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
7 <param name="input" type="data" format="fasta" label="Fasta file"/>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
8 <param name="species" type="select" label="Species">
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
9 <option value="human">Homo sapiens</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
10 <option value="mouse">Mus musculus</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
11 <option value="rat">Rattus norvegicus</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
12 <option value="rabbit">Oryctolagus cuniculus</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
13 <option value="rhesus_monkey">Macaca mulatta</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
14 </param>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
15 <param name="locus" type="select" label="Locus">
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
16 <option value="TRA">TRA</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
17 <option value="TRB">TRB</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
18 <option value="TRG">TRG</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
19 <option value="TRD">TRD</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
20 <option value="IGH">IGH</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
21 <option value="IGK">IGK</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
22 <option value="IGL">IGL</option>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
23 </param>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
24 </inputs>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
25 <outputs>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
26 <data name="output" format="tabular" type="data" label="${input.name}-igBLASTn aligned"/>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
27 <!--<data name="log" format="text" label="log"/>-->
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
28 </outputs>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
29 <requirements>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
30 <requirement type="package" version="0.6">igblastwrp</requirement>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
31 </requirements>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
32 <help>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
33 ============
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
34 iReport
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
35 ============
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
36
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
37 This tool uses the online igBLAST website hosted by NCBI to blast a FASTA file, it retrieves the result and generates a convenient tabular format for further processing.
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
38
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
39 **NOTE**
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
40
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
41 .. class:: warningmark
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
42
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
43 - Everything goes through the servers of NCBI, so if you have sensitive data that that isn't allowed to leave your local network, this isn't the tool the use.
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
44
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
45 **USAGE**
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
46
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
47 .. class:: infomark
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
48
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
49 - This tool uses a free service provided by NCBI, and although there doesn't seem to be any restrictions on usage, avoid unnecessary usage to lighten the load on NCBI's servers.
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
50
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
51
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
52 **INPUT**
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
53
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
54 This tool accepts FASTA files as input:
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
55
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
56 ::
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
57
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
58 >lcl|FLN1FA002RWEZA.1|
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
59 ggctggagtgggtttcatacattagtagtaatagtggtgccatatactacgcagactctgtgaagggccgattcaccatc
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
60 tccagaaacaatgccaaggactcactgtatctgcaaatgaacagcctgagagccgaggacacggctgtgtattactgtgc
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
61 gagagcgatcccccggtattactatgatactagtggcccaaacgactactggggccagggaaccctggtcaccgtctcct
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
62 cag
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
63 >lcl|FLN1FA001BLION.1|
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
64 aggcttgagtggatgggatggatcaacgctggcaatggtaacacaaaatattcacagaagttccagggcagagtcaccat
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
65 taccagggacacatccgcgagcacagcctacatggagctgagcagcctgagatctgaagacacggctgtgtattactgtg
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
66 cgagagtgggcagcagctggtctgatgcttttgattatctggggccaagggacaatggtcaccgtctcctcag
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
67
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
68 **OUTPUT**
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
69
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
70 The following data is used for ARGalaxy
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
71
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
72 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
73 | Column name | Column contents |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
74 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
75 | ID | The Sequence ID provided by the sequencer. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
76 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
77 | VDJ Frame | In-frame/Out-frame |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
78 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
79 | Top V Gene | The best matching V gene found. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
80 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
81 | Top D Gene | The best matching D gene found. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
82 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
83 | Top J Gene | The best matching J gene found. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
84 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
85 | CDR3 Seq | The CDR3 region. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
86 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
87 | CDR3 Length | The length of the CDR3 region. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
88 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
89 | CDR3 Seq DNA | The CDR3 sequence region. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
90 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
91 | CDR3 Length DNA | The length of the CDR3 sequence region. |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
92 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
93 | Functionality | If sequence is productive/unproductive |
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
94 +-----------------+----------------------------------------------+
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
95
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
96
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
97 </help>
afe85eb6572e Uploaded
davidvanzessen
parents:
diff changeset
98 </tool>