insitupy.plotting.plot_overview

Contents

insitupy.plotting.plot_overview#

insitupy.plotting.plot_overview(data, cells_layer=None, colums_to_plot=[], layer=None, force_layer=False, index=True, qc_width=4.0, savepath=None, save_only=False, dpi_save=300)#

Plots an overview table with metadata and quality control metrics.

Parameters:

  • columns_to_plot (List[str]) – List of column names to include in the plot.

  • layer (str, optional) – The layer of the AnnData object to use for calculations. If None, the function will use the main matrix (adata.X) or the ‘counts’ layer if the main matrix does not contain integer counts.

  • force_layer (bool, optional) – Whether to use specifies layer even if not integers in count matrix.

  • index (bool, optional) – Whether to add extra index or not. Default is True.

  • custom_width (float, optional) – Custom width for metadata columns. Default is 1.0.

  • qc_width (float, optional) – Width for quality control metric columns. Default is 4.0.

Raises:

ImportError – If the ‘plottable’ framework is not installed.

Returns:

Displays a plot with the overview table.

Return type:

None

Contents