annotate igblastn.xml @ 6:d001d0c05dbe draft

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