annotate igblastn.xml @ 63:7997fea1f16a draft default tip

Uploaded
author davidvanzessen
date Thu, 06 Nov 2014 03:31:15 -0500
parents a700a552f031
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
1 <tool id="igblastn" name="igBLASTn" version="0.1.0">
61
39a916965683 Uploaded
davidvanzessen
parents: 55
diff changeset
2 <description> </description>
63
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
3 <command interpreter="python">
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
4 igblast_post.py --input $input --output $output
0
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
5 </command>
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
6 <inputs>
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
7 <param name="input" type="data" format="fasta" label="Fasta file"/>
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
8 </inputs>
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
9 <outputs>
63
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
10 <data name="output" format="tabular" type="data" label="${input.name}-igBLASTn Report"/>
0
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
11 <!--<data name="log" format="text" label="log"/>-->
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
12 </outputs>
63
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
13 <requirements>
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
14 <requirement type="package" version="1.0.0">igBlastn</requirement>
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
15 </requirements>
0
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
16 <help>
63
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
17 ============
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
18 iReport
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
19 ============
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
20
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
21 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.
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
22
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
23 **NOTE**
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
24
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
25 .. class:: warningmark
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
26
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
27 - 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.
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
28
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
29 **USAGE**
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
30
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
31 .. class:: infomark
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
32
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
33 - 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.
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
34
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
35
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
36 **INPUT**
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
37
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
38 This tool accepts FASTA files as input:
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
39
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
40 ::
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
41
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
42 >lcl|FLN1FA002RWEZA.1|
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
43 ggctggagtgggtttcatacattagtagtaatagtggtgccatatactacgcagactctgtgaagggccgattcaccatc
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
44 tccagaaacaatgccaaggactcactgtatctgcaaatgaacagcctgagagccgaggacacggctgtgtattactgtgc
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
45 gagagcgatcccccggtattactatgatactagtggcccaaacgactactggggccagggaaccctggtcaccgtctcct
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
46 cag
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
47 >lcl|FLN1FA001BLION.1|
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
48 aggcttgagtggatgggatggatcaacgctggcaatggtaacacaaaatattcacagaagttccagggcagagtcaccat
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
49 taccagggacacatccgcgagcacagcctacatggagctgagcagcctgagatctgaagacacggctgtgtattactgtg
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
50 cgagagtgggcagcagctggtctgatgcttttgattatctggggccaagggacaatggtcaccgtctcctcag
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
51
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
52 **OUTPUT**
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
53
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
54 The following data is used for ARGalaxy
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
55
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
56 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
57 | Column name | Column contents |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
58 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
59 | ID | The Sequence ID provided by the sequencer. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
60 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
61 | VDJ Frame | In-frame/Out-frame |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
62 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
63 | Top V Gene | The best matching V gene found. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
64 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
65 | Top D Gene | The best matching D gene found. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
66 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
67 | Top J Gene | The best matching J gene found. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
68 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
69 | CDR3 Seq | The CDR3 region. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
70 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
71 | CDR3 Length | The length of the CDR3 region. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
72 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
73 | CDR3 Seq DNA | The CDR3 sequence region. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
74 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
75 | CDR3 Length DNA | The length of the CDR3 sequence region. |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
76 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
77 | Functionality | If sequence is productive/unproductive |
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
78 +-----------------+----------------------------------------------+
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
79
7997fea1f16a Uploaded
davidvanzessen
parents: 62
diff changeset
80
0
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
81 </help>
a5954de04a3d Uploaded
davidvanzessen
parents:
diff changeset
82 </tool>