annotate readme.rst @ 5:2950d5afa3fe draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
author iuc
date Mon, 05 Dec 2016 12:11:06 -0500
parents 500832f27cbc
children 7adfd0589f49
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
1 SnpEff wrappers
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
2 ===============
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
3
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
4 These are galaxy tools for SnpEff_, a variant annotation and effect prediction tool by Pablo Cingolani.
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
5 It annotates and predicts the effects of variants on genes (such as amino acid changes).
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
6
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
7 .. _SnpEff: http://snpeff.sourceforge.net/
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
8
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
9
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
10 This repository let you automatically install SnpEff and SnpSift.
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
11 This will use the default location for genome reference downloads from the ``snpEff.config`` file:
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
12
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
13 data_dir = ~/snpEff/data/
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
14
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
15 You can manually edit the installed ``snpEff.config`` file and change the location, or you can create a symbolic link to the desired data location from ``~/snpEff``.
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
16
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
17 The genome reference options used by the tools "SnpEff" (snpEff.xml) and "SnpEff Download" (snpEff_download.xml) are taken from the ``tool-data/snpeffect_genomedb.loc`` file.
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
18 You can fill this file by running the following command:
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
19
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
20 java -jar snpEff.jar databases | tail -n +3 | cut -f 1,2 | awk '{ gsub(/_/, " ", $2); printf "%s\\t%s : %s\\n", $1, $2, $1 }' | sort -k 2 > snpeffect_genomedb.loc
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
21
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
22 There are 2 datamanagers to download and install prebuilt SnpEff genome databases:
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
23
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
24 * data_manager_snpeff_databases: generates a list of available SnpEff genome databases into the ``tool-data/snpeff_databases.loc`` file
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
25 * data_manager_snpeff_download: downloads a SnpEff genome database selected from ``tool-data/snpeff_databases.loc`` and adds entries to ``snpeff_genomedb.loc``, ``snpeff_regulationdb.loc`` and ``snpeff_annotations.loc``
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
26
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
27 SnpEff citation: |Cingolani2012program|_.
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
28
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
29 .. |Cingolani2012program| replace:: Cingolani, P., Platts, A., Wang, L. L., Coon, M., Nguyen, T., Wang, L., Land, S. J., Lu, X., Ruden, D. M. (2012) A program for annotating and predicting the effects of single nucleotide polymorphisms, SnpEff: SNPs in the genome of *Drosophila melanogaster* strain w1118; iso-2; iso-3. *Fly* 6(2):80-92
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
30 .. _Cingolani2012program: https://www.landesbioscience.com/journals/fly/article/19695/
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
31
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
32 SnpSift citation: |Cingolani2012using|_.
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
33
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
34 .. |Cingolani2012using| replace:: Cingolani, P., Patel, V. M., Coon, M., Nguyen, T., Land, S. J., Ruden, D. M., Lu, X. (2012) Using *Drosophila melanogaster* as a model for genotoxic chemical mutational studies with a new program, SnpSift. *Front. Genet.* 3:35
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
35 .. _Cingolani2012using: http://journal.frontiersin.org/Journal/10.3389/fgene.2012.00035/
0
e8adfc4c0a6b Uploaded
iuc
parents:
diff changeset
36
1
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
37 Wrapper authors: Jim Johnson
500832f27cbc Uploaded
iuc
parents: 0
diff changeset
38