Mercurial > repos > vimalkumarvelayudhan > riboplot

annotate docs/readme.rst @ 11:7571f5c89090

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Simple error message now output to HTML. Detailed error goes to standard error. Other changes: * Remove information on time taken (riboplot). * Remove striped table styles (not used. unusable on sorting). * log before re-raising errors.
author Vimalkumar Velayudhan <vimal@biotechcoder.com>
date Wed, 19 Aug 2015 10:14:52 +0100
parents 8964641b04ef
children 628f82e72d72
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
1 ===============================
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
2 RiboPlot
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
3 ===============================
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
4
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
5 .. image:: https://img.shields.io/travis/vimalkumarvelayudhan/riboplot.svg
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
6 :target: https://travis-ci.org/vimalkumarvelayudhan/riboplot
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
8 .. image:: https://img.shields.io/pypi/v/riboplot.svg
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
9 :target: https://pypi.python.org/pypi/riboplot
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
10
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
11
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
12 RiboPlot includes programs to plot and output Ribo-Seq read counts from an alignment file (BAM format).
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
13
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
14 There are two programs in the package:
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
15
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
16 **riboplot**
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
17 Plot and output read counts (csv) for a single transcript.
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
18
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
19 **ribocount**
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
20 Output read counts for all transcripts in an alignment.
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
21
10
8964641b04ef Fix usage link
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
22 For help on using these programs, please refer to :ref:`usage`.
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
23
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
24
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
25 Free software: BSD license.
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
26
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
27 Documentation: https://riboplot.readthedocs.org.
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 5
diff changeset
28