Mercurial > repos > iuc > gemini_burden

annotate readme.rst @ 3:1a4c5adcd587 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gemini commit 1f7418d74c6fcd61a050106ca5f9b66ab9a4c33d
author iuc
date Wed, 17 Oct 2018 13:28:45 -0400
parents e799c1a6854b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
1 =========================
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
2 Galaxy wrapper for GEMINI
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
3 =========================
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
4
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
5
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
6 GEMINI: a flexible framework for exploring genome variation
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
7
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
8 GEMINI (GEnome MINIng) is designed to be a flexible framework for exploring genetic variation in the context of
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
9 the wealth of genome annotations available for the human genome. By placing genetic variants, sample genotypes,
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
10 and useful genome annotations into an integrated database framework, GEMINI provides a simple, flexible, yet very
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
11 powerful system for exploring genetic variation for for disease and population genetics.
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
12
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
13 Using the GEMINI framework begins by loading a VCF file into a database. Each variant is automatically
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
14 annotated by comparing it to several genome annotations from source such as ENCODE tracks, UCSC tracks,
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
15 OMIM, dbSNP, KEGG, and HPRD. All of this information is stored in portable SQLite database that allows
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
16 one to explore and interpret both coding and non-coding variation using “off-the-shelf” tools or an
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
17 enhanced SQL engine.
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
18
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
19 Please also see the original [manuscript](http://www.ploscompbiol.org/article/info%3Adoi%2F10.1371%2Fjournal.pcbi.1003153).
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
20
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
21
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
22 ============
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
23 Installation
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
24 ============
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
25
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
26 It is recommended to install this wrapper via the `Galaxy Tool Shed`.
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
27
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
28 .. _`Galaxy Tool Shed`: https://testtoolshed.g2.bx.psu.edu/view/iuc/gemini
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
29
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
30
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
31 =======
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
32 History
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
33 =======
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
34 - 0.9.1: Initial public release
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
35
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
36
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
37 ====================
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
38 Detailed description
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
39 ====================
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
40
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
41 View the original GEMINI documentation: http://gemini.readthedocs.org/en/latest/index.html
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
42
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
43
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
44 ===============================
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
45 Wrapper Licence (MIT/BSD style)
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
46 ===============================
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
47
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
48 Permission to use, copy, modify, and distribute this software and its
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
49 documentation with or without modifications and for any purpose and
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
50 without fee is hereby granted, provided that any copyright notices
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
51 appear in all copies and that both those copyright notices and this
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
52 permission notice appear in supporting documentation, and that the
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
53 names of the contributors or copyright holders not be used in
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
54 advertising or publicity pertaining to distribution of the software
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
55 without specific prior permission.
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
56
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
57 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
58 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
59 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
60 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
61 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
62 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
63 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
64 OR PERFORMANCE OF THIS SOFTWARE.
e799c1a6854b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
65