annotate README @ 44:a8b31d446fec draft default tip

updated vhom regions with multiple hit file input and adapted visualization
author mzeidler
date Mon, 04 Nov 2013 11:57:55 -0500
parents 53a6b7a0d10c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
1 ***Virana***
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
2
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
3 **The Virus Analysis Toolkit**
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
4
40
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
5 Virana, the virus analysis toolkit, is a Python-based software toolkit for analyzing metatranscriptomic (and, to a degree, metagenomic) sequence data in a context of clinical metagenomics in order to:
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
6
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
7 - identify pathogen nucleotide sequences in transcriptomic (and, while less tested, genomic) short read data
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
8 - identify pathogen transcripts diverged from known references of various microbial species
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
9 - identify transcripts expressed at low abundances across multiple samples
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
10 - identify transcripts homologous to human factors such as certain viral oncogenes
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
11
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
12 A recent analysis of human tumor transcriptomes displays the ability of Virana to detect diverged viral nucleotide sequences and human-viral homologs with high sensitivity.
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
13 The manuscript is available at doi:10.1371/journal.pcbi.1003228 and http://www.ploscompbiol.org/article/info:doi/10.1371/journal.pcbi.1003228
0
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
14
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
15
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
16 **Licence**
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
17
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
18 For licence information see https://github.com/schelhorn/virana/raw/master/LICENSE
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
19
40
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
20
0
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
21 **Installation**
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
22
40
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
23 Using the virana tool shed repository, all dependencies are installed automatically.
0
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
24
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
25
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
26 **Usage**
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
27
40
53a6b7a0d10c Uploaded
mzeidler
parents: 0
diff changeset
28 There is an example workflow in the virana tool shed repository. Feel free to import the workflow and get familiar with the usage of the toolkit.
0
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
29
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
30
f63d639b223c Initial Upload
mzeidler
parents:
diff changeset
31