Mercurial > repos > vimalkumarvelayudhan > riboplot

annotate README.rst @ 41:45f5550a0aa3 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author vimalkumarvelayudhan
date Fri, 24 Nov 2017 06:17:14 -0500
parents 415fc38fbae1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31
c330ef264927 Update README. Remove travis/pypi links
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 30
diff changeset
1 RiboPlot
c330ef264927 Update README. Remove travis/pypi links
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 30
diff changeset
2 ========
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
3 RiboPlot includes programs to plot and output Ribo-Seq read counts from an alignment file (BAM format).
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
4
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
5 There are two programs in the package:
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
6
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
7 **riboplot**
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
8
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
9 Plot and output read counts (csv) for a single transcript.
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
10
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
11 **ribocount**
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
12
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
13 Output read counts for all transcripts in an alignment.
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
14
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
15 Free software: GPL license
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
16
32
b0ae69eb1712 Use latest version of riboplot (0.2.0)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 31
diff changeset
17 Documentation: http://pythonhosted.org/riboplot
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
18
34
3c6ce517b9f2 Testing whl bundle install
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 32
diff changeset
19 Repository: https://github.com/vimalkvn/riboplot
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
20
28
60bbd8ebe314 Working install (virtualenv)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 19
diff changeset
21
60bbd8ebe314 Working install (virtualenv)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 19
diff changeset
22 .. note::
60bbd8ebe314 Working install (virtualenv)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 19
diff changeset
23
40
415fc38fbae1 Uploaded
vimalkumarvelayudhan
parents: 34
diff changeset
24 RNA coverage plot requires `bedtools <https://github.com/arq5x/bedtools2>`_.
415fc38fbae1 Uploaded
vimalkumarvelayudhan
parents: 34
diff changeset
25 This release of riboplot has been tested with bedtools version ``2.24.0``.
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
26
40
415fc38fbae1 Uploaded
vimalkumarvelayudhan
parents: 34
diff changeset
27 If you have conda enabled on Galaxy, then all dependencies including bedtools
415fc38fbae1 Uploaded
vimalkumarvelayudhan
parents: 34
diff changeset
28 will be installed automatically.
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
29
40
415fc38fbae1 Uploaded
vimalkumarvelayudhan
parents: 34
diff changeset
30 Otherwise, on Ubuntu and derivatives, bedtools can be installed from the
415fc38fbae1 Uploaded
vimalkumarvelayudhan
parents: 34
diff changeset
31 repositories using::
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
32
28
60bbd8ebe314 Working install (virtualenv)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 19
diff changeset
33 sudo apt-get install bedtools
19
cff63cf0dea8 Update tool_dependencies to install package from pip
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 15
diff changeset
34