1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
.. pybedtools documentation master file, created by
sphinx-quickstart on Wed Dec 22 17:39:12 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. include:: includeme.rst
`pybedtools` documentation
==========================
.. include:: ../../README.rst
As of 2022, `pybedtools` is released under the MIT license; see LICENSE.txt for
more info.
.. note::
If you use :mod:`pybedtools` in your work, please cite the `pybedtools
manuscript <http://bioinformatics.oxfordjournals.org/content/27/24/3423>`_
and the `BEDTools manuscript
<http://bioinformatics.oxfordjournals.org/content/26/6/841.short>`_:
Dale RK, Pedersen BS, and Quinlan AR. 2011. *Pybedtools: a flexible
Python library for manipulating genomic datasets and annotations*.
Bioinformatics 27(24):3423-3424.
Quinlan AR and Hall IM, 2010. *BEDTools: a flexible suite of utilities
for comparing genomic features*. Bioinformatics 26(6):841–842.
Getting started
---------------
The documentation is separated into 4 main parts, depending on the depth you'd
like to cover:
* Lazy, or just want to jump in? Check out :ref:`3examples` to
get a feel for the package.
* Want a guided tour? Give the :ref:`tutorial` a shot.
* More advanced features are described in the :ref:`topical` section.
* Finally, doctested module documentation can be found in :ref:`autodoc`.
Contents:
---------
.. toctree::
:maxdepth: 2
main
3-brief-examples
tutorial-contents
topical-documentation-contents
FAQs
scripts
autodoc_source
changes
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
