trackc.pl.mapc_markline#

trackc.pl.mapc_markline(ax: Axes | None = None, row_regions: DataFrame | None = None, mark_regions: Sequence[str] | str | None = None, binsize: int | None = 10000, map_order: int = 0, map_type: str | None = 'squ', symmetric: bool = False, trans_ax: bool = False, only_cis: bool = False, linestyle: str | None = '--', linecolor: str | None = 'k', linewidth: int | None = 1, show_regions_edge: bool = False)[source]#

The mapc_markline function used for mark contact regions on the heatmap, It should be used in conjunction with mapc. The parameters “symmetric” and “trans_ax” which should be consistent with the parameters used in mapc.

Parameters:

  • ax (matplotlib.axes.Axes object) – utilizes the same Axes as used in mapc

  • row_regions (pd.DataFrame) – The row_regions attribute of the object returned by tc.tl.extractContactRegions represents the regions extracted from the rows.

  • mark_regions (np.ndarray) – matrix for plot upper or right of heatmap

  • binsize (int) – binsize of raw heatmap

  • map_order (int) – one option of [0, 1] The map_order parameter in the context of trackc.mapc is associated with the mat and mat2 parameters. If use trackc.mapc to generate a heatmap in the top-right quadrant, then for “map_order” here, you should set it to 0. If you use “mapc” to generate a heatmap in the bottom-left quadrant, then for “map_order” here, you should also set it to 0.

  • map_type (str) – same as the trackc.mapc map_type parameter. optional is [‘square’, ‘squ’, ‘triangle’, ‘tri’, ‘rectangle’, ‘rec’], default is square que is the same as square, tri is the same as triangle, rec is the same as rectangle.

  • symmetric (bool) – same as the trackc.mapc symmetric parameter.

  • trans_ax (bool) – same as the trackc.mapc trans_ax parameter.

  • only_cis (bool) – If set to True, the trans regions will not be displayed.

  • linestyle (str) – mark line style

  • linecolor (str) – mark line color

  • linewidth (int) – mark line width

  • show_regions_edge (bool) – Whether to display the spliced region as input from the row_regions parameter