Customizable options#

Functions related to check, set and reset the plot customizable options. For graphical explanation check the first figure of the Tutorial.

pyrangeyes.print_options(return_keys=False, *, adapter=None)#

Print customizable plot or adapter options.

Parameters:

  • return_keys (bool or str, default False) – If True, return the option-name set instead of printing a table. Passing an adapter name here, for example print_options("mRNA"), prints options for that adapter.

  • adapter (str, optional keyword-only) – Adapter whose options should be printed, for example "mRNA".

pyrangeyes.get_options(varname='all', *, adapter=None)#

Obtain plot-layout options, or adapter options when adapter is given.

Parameters:

  • varname (str or list, default 'all') –

    Option name(s) to retrieve.

    • "all" returns the full {option: (value, description, modified)} mapping.

    • "values" returns only current values as {option: value}.

    • A list returns option values in the same order.

    • A single option name returns one current value.

  • adapter (str, optional keyword-only) – Adapter whose options should be read, for example "mRNA". Adapter functions use their DEFAULT sentinel to pull current values from this option store at runtime.

pyrangeyes.set_options(varname=None, value=None, *, adapter=None, variable=None)#

Define plot-layout options, or adapter options when adapter is given.

Parameters:

  • varname (str or dict, optional) –

    Plot option name to change, or a dictionary with {option: value} pairs. Use print_options() to inspect available plot options.

    When adapter is provided, this is the adapter option name unless variable is also provided.

  • value (object, optional) – New value assigned to varname or variable.

  • adapter (str, optional keyword-only) – Adapter whose options should be changed, for example "mRNA".

  • variable (str or dict, optional keyword-only) – Alias for varname when setting adapter options. This makes calls such as set_options(adapter="mRNA", variable="utr_height", value=0.5) explicit while preserving the original positional API.

Examples

>>> import pyrangeyes as pe

>>> pe.set_options('track_bg', 'magenta')

>>> pe.set_options('title_size', 20)

>>> pe.set_options({'track_bg': 'magenta', 'title_size': 20})

>>> pe.set_options(adapter='mRNA', variable='utr_height', value=0.5)
pyrangeyes.reset_options(varname='all', *, adapter=None)#

Reset one, some, or all plot-layout options to their original value.

When adapter is provided, reset options for that adapter instead.

Parameters:

  • varname (str or list, default 'all') – Option name, list of names, or "all".

  • adapter (str, optional keyword-only) – Adapter whose options should be reset, for example "mRNA".

Examples

>>> import pyrangeyes as pe

>>> pe.reset_options()

>>> pe.reset_options('all')

>>> pe.reset_options('tag_bkg')

>>> pe.reset_options(['title_size', 'tag_bkg'])

>>> pe.reset_options(adapter='mRNA')