annotate igblastn.xml @ 75:899ca5c9601f draft default tip

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