Register methods

Register pyrangeyes convenience methods on PyRanges objects.

register_methods() adds both .plot() and .track() to pyranges.PyRanges.

pyrangeyes.register_methods(engine=None)

Register pyrangeyes convenience methods on PyRanges.

Adds PyRanges.plot(...) and PyRanges.track(...). Optionally, set the plotting engine.

Parameters:

engine ({str}, default None) – Optional string to set the engine for plotting: Matplotlib (‘plt’, ‘matplotlib’) or Plotly (‘ply’, ‘plotly’).

Examples

>>> import pyrangeyes as pe

>>> pe.register_methods()

>>> pe.register_methods("matplotlib")