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 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
|
.. _api-reference:
API Reference
=============
.. toctree::
:maxdepth: 1
Quick reference
---------------
Cooler class
~~~~~~~~~~~~
.. autosummary::
cooler.Cooler
cooler.Cooler.binsize
cooler.Cooler.chromnames
cooler.Cooler.chromsizes
cooler.Cooler.bins
cooler.Cooler.pixels
cooler.Cooler.matrix
cooler.Cooler.open
cooler.Cooler.info
cooler.Cooler.offset
cooler.Cooler.extent
Creation/reduction
~~~~~~~~~~~~~~~~~~
.. autosummary::
cooler.create_cooler
cooler.merge_coolers
cooler.coarsen_cooler
cooler.zoomify_cooler
cooler.create_scool
Manipulation
~~~~~~~~~~~~
.. autosummary::
cooler.annotate
cooler.balance_cooler
cooler.rename_chroms
File operations
~~~~~~~~~~~~~~~
.. autosummary::
cooler.fileops.is_cooler
cooler.fileops.is_multires_file
cooler.fileops.list_coolers
cooler.fileops.cp
cooler.fileops.mv
cooler.fileops.ln
.. Sandbox
.. ~~~~~~~
.. .. autosummary::
.. cooler.sandbox.dask.read_table
----
cooler
------
.. autoclass:: cooler.Cooler
:members:
.. autofunction:: cooler.annotate
.. autofunction:: cooler.create_cooler
.. autofunction:: cooler.merge_coolers
.. autofunction:: cooler.coarsen_cooler
.. autofunction:: cooler.zoomify_cooler
.. autofunction:: cooler.balance_cooler
.. autofunction:: cooler.rename_chroms
.. autofunction:: cooler.create_scool
----
cooler.create
-------------
.. autofunction:: cooler.create.sanitize_pixels
.. autofunction:: cooler.create.sanitize_records
cooler.fileops
--------------
.. autofunction:: cooler.fileops.is_cooler
.. autofunction:: cooler.fileops.is_multires_file
.. autofunction:: cooler.fileops.list_coolers
.. autofunction:: cooler.fileops.cp
.. autofunction:: cooler.fileops.mv
.. autofunction:: cooler.fileops.ln
cooler.util
-----------
.. autofunction:: cooler.util.partition
.. autofunction:: cooler.util.fetch_chromsizes
.. autofunction:: cooler.util.read_chromsizes
.. autofunction:: cooler.util.binnify
.. autofunction:: cooler.util.digest
.. cooler.sandbox
.. --------------
.. .. autofunction:: cooler.sandbox.dask.read_table
|