marsilea 0.4.8__py3-none-any.whl → 0.5.0__py3-none-any.whl

marsilea/__init__.py

@@ -1,6 +1,6 @@
 """Declarative creation of composable visualization"""
 
-__version__ = "0.4.8"
+__version__ = "0.5.0"
 
 import marsilea.plotter as plotter
 from ._deform import Deformation

marsilea/base.py

@@ -1142,142 +1142,6 @@ class ClusterBoard(WhiteBoard):
                 rasterized=rasterized,
             )
 
-    def hsplit(self, cut=None, labels=None, order=None, spacing=0.01):
-        """Split the main canvas horizontally
-
-        .. deprecated:: 0.5.0
-            Use :meth:`~marsilea.base.ClusterBoard.cut_rows` \
-            or :meth:`~marsilea.base.ClusterBoard.group_rows` instead
-
-        Parameters
-        ----------
-        cut : array-like, optional
-            The index of your data to specify where to split the canvas
-        labels : array-like, optional
-            The labels of your data, must be the same length as the data
-        order : array-like, optional
-            The order of the unique labels
-        spacing : float, optional
-            The spacing between each split chunks, default is 0.01
-
-        Examples
-        --------
-        Split the canvas by the unique labels
-
-        .. plot::
-            :context: close-figs
-
-            >>> data = np.random.rand(10, 11)
-            >>> import marsilea as ma
-            >>> h = ma.Heatmap(data)
-            >>> labels = ["A", "B", "C", "A", "B", "C", "A", "B", "C", "A"]
-            >>> h.hsplit(labels=labels, order=["A", "B", "C"])
-            >>> h.add_left(ma.plotter.Labels(labels), pad=.1)
-            >>> h.render()
-
-
-        Split the canvas by the index
-
-        .. plot::
-            :context: close-figs
-
-            >>> h = ma.Heatmap(data)
-            >>> h.hsplit(cut=[4, 8])
-            >>> h.render()
-
-
-        """
-        warnings.warn(
-            DeprecationWarning(
-                "`hsplit` will be deprecated in v0.5.0, use `cut_rows` or `group_rows` instead"
-            ),
-            stacklevel=2,
-        )
-        if self._split_row:
-            raise SplitTwice(axis="horizontally")
-        self._split_row = True
-
-        deform = self.get_deform()
-        deform.hspace = spacing
-        if cut is not None:
-            deform.set_split_row(breakpoints=cut)
-        else:
-            labels = np.asarray(labels)
-
-            reindex, order = reorder_index(labels, order=order)
-            deform.set_data_row_reindex(reindex)
-
-            breakpoints = get_breakpoints(labels[reindex])
-            deform.set_split_row(breakpoints=breakpoints, order=order)
-
-    def vsplit(self, cut=None, labels=None, order=None, spacing=0.01):
-        """Split the main canvas vertically
-
-        .. deprecated:: 0.5.0
-            Use :meth:`~marsilea.base.ClusterBoard.cut_cols` \
-            or :meth:`~marsilea.base.ClusterBoard.group_cols` instead
-
-        Parameters
-        ----------
-        cut : array-like, optional
-            The index of your data to specify where to split the canvas
-        labels : array-like, optional
-            The labels of your data, must be the same length as the data
-        order : array-like, optional
-            The order of the unique labels
-        spacing : float, optional
-            The spacing between each split chunks, default is 0.01
-
-        Examples
-        --------
-        Split the canvas by the unique labels
-
-        .. plot::
-            :context: close-figs
-
-            >>> data = np.random.rand(10, 11)
-            >>> import marsilea as ma
-            >>> h = ma.Heatmap(data)
-            >>> labels = ["A", "B", "C", "A", "B", "C", "A", "B", "C", "A", "B"]
-            >>> h.vsplit(labels=labels, order=["A", "B", "C"])
-            >>> h.add_top(ma.plotter.Labels(labels), pad=.1)
-            >>> h.render()
-
-
-        Split the canvas by the index
-
-        .. plot::
-            :context: close-figs
-
-            >>> h = ma.Heatmap(data)
-            >>> h.vsplit(cut=[4, 8])
-            >>> h.render()
-
-
-        """
-        warnings.warn(
-            DeprecationWarning(
-                "`vsplit` will be deprecated in v0.5.0, use `cut_cols` or `group_cols` instead"
-            ),
-            stacklevel=2,
-        )
-        if self._split_col:
-            raise SplitTwice(axis="vertically")
-        self._split_col = True
-
-        deform = self.get_deform()
-        deform.wspace = spacing
-        if cut is not None:
-            deform.set_split_col(breakpoints=cut)
-        else:
-            labels = np.asarray(labels)
-
-            reindex, order = reorder_index(labels, order=order)
-            deform.set_data_col_reindex(reindex)
-
-            breakpoints = get_breakpoints(labels[reindex])
-            deform.set_split_col(breakpoints=breakpoints, order=order)
-
     def group_rows(self, group, order=None, spacing=0.01):
         """Group rows into chunks
 

marsilea/heatmap.py

@@ -50,6 +50,7 @@ class Heatmap(ClusterBoard):
         height=None,
         cluster_data=None,
         init_main=True,
+        legend=True,
         **kwargs,
     ):
         if cluster_data is None:
@@ -80,7 +81,7 @@ class Heatmap(ClusterBoard):
         )
         name = get_plot_name(name, "main", mesh.__class__.__name__)
         mesh.set(name=name)
-        self.add_layer(mesh)
+        self.add_layer(mesh, legend=legend)
 
 
 class CatHeatmap(ClusterBoard):
@@ -109,6 +110,7 @@ class CatHeatmap(ClusterBoard):
         name=None,
         width=None,
         height=None,
+        legend=True,
         cluster_data=None,
         linewidth=0,
         linecolor="white",
@@ -128,7 +130,7 @@ class CatHeatmap(ClusterBoard):
         super().__init__(cluster_data, width=width, height=height, name=name)
         name = get_plot_name(name, "main", mesh.__class__.__name__)
         mesh.set(name=name)
-        self.add_layer(mesh)
+        self.add_layer(mesh, legend=legend)
 
 
 class SizedHeatmap(ClusterBoard):
@@ -156,6 +158,7 @@ class SizedHeatmap(ClusterBoard):
         name=None,
         width=None,
         height=None,
+        legend=True,
         **kwargs,
     ):
         if cluster_data is None:
@@ -166,4 +169,4 @@ class SizedHeatmap(ClusterBoard):
         super().__init__(cluster_data, width=width, height=height, name=name)
 
         mesh = SizedMesh(size=size, color=color, **kwargs)
-        self.add_layer(mesh)
+        self.add_layer(mesh, legend=legend)

{marsilea-0.4.8.dist-info → marsilea-0.5.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: marsilea
-Version: 0.4.8
-Dynamic: Summary
+Version: 0.5.0
+Summary: Declarative creation of composable visualizations
 Project-URL: Home, https://github.com/Marsilea-viz/marsilea
-Author: Zhihang Zheng
-Author-email: Mr-Milk <yzheng@cemm.at>
+Project-URL: Documentation, https://marsilea.readthedocs.io
+Author-email: Yimin Zheng <yzheng@cemm.at>, Zhihang Zheng <zhihang.zheng@connect.polyu.hk>
 License: The MIT License (MIT)
         
-        Copyright (c) 2024 Mr-Milk
+        Copyright (c) 2025 Yimin Zheng
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
@@ -30,6 +30,8 @@ License-File: LICENSE
 Classifier: Framework :: Matplotlib
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Visualization
 Requires-Python: >=3.8
 Requires-Dist: legendkit
 Requires-Dist: matplotlib>=3.6
@@ -38,20 +40,6 @@ Requires-Dist: pandas[parquet]
 Requires-Dist: platformdirs
 Requires-Dist: scipy
 Requires-Dist: seaborn
-Provides-Extra: dev
-Requires-Dist: icecream; extra == 'dev'
-Requires-Dist: mpl-fontkit; extra == 'dev'
-Requires-Dist: numpydoc; extra == 'dev'
-Requires-Dist: pre-commit; extra == 'dev'
-Requires-Dist: pydata-sphinx-theme; extra == 'dev'
-Requires-Dist: pytest; extra == 'dev'
-Requires-Dist: python-hmr; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Requires-Dist: scikit-learn; extra == 'dev'
-Requires-Dist: sphinx; extra == 'dev'
-Requires-Dist: sphinx-copybutton; extra == 'dev'
-Requires-Dist: sphinx-design; extra == 'dev'
-Requires-Dist: sphinx-gallery; extra == 'dev'
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -66,6 +54,7 @@ Description-Content-Type: text/markdown
 ![pypi version](https://img.shields.io/pypi/v/marsilea?color=0098FF&logo=python&logoColor=white&style=flat-square)
 ![Conda Version](https://img.shields.io/conda/vn/conda-forge/marsilea?style=flat-square&logo=anaconda&logoColor=white&color=%2344A833)
 ![PyPI - License](https://img.shields.io/pypi/l/marsilea?color=FFD43B&style=flat-square)
+[![DOI](https://img.shields.io/badge/DOI-10.1186%2Fs13059--024--03469--3-blue?color=0098FF&style=flat-square)](https://doi.org/10.1186/s13059-024-03469-3)
 
 # Marsilea: Declarative creation of composable visualization!
 
@@ -104,6 +93,16 @@ and then create a bar chart to show the expression of genes in different cell ty
 A visualization contains multiple plots is called a composable visualization.
 In Marsilea, we employ a declarative approach for user to create composable visualization incrementally.
 
+## Citation
+
+If you use Marsilea in your research, please cite the following:
+
+> Marsilea: an intuitive generalized paradigm for composable visualizations
+> 
+> Yimin Zheng, Zhihang Zheng, André F. Rendeiro & Edwin Cheung
+> 
+> _Genome Biology_ 2025 Jan 06. DOI: [10.1186/s13059-017-1382-0](https://doi.org/10.1186/s13059-024-03469-3)
+
 ## Examples
 
 <table>

{marsilea-0.4.8.dist-info → marsilea-0.5.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
-marsilea/__init__.py,sha256=4gKfHq47N9IViIzNNmV_ESrbrDwd1Lx2HnVonhJH42c,595
+marsilea/__init__.py,sha256=0ws5dRLTu-1jr567U5FStwBhguxacSpj6oijY_23Eio,595
 marsilea/_api.py,sha256=tymWZHfjhx8-0NNd9762znfdIu36NrARRweEIr5L1mA,283
 marsilea/_deform.py,sha256=QRz4OGXMsQzbiIkC3ASzZayMPhHhoFsEK38oBzSeQG8,14440
-marsilea/base.py,sha256=WTQ1L2Geyt4KjrWWQMSrS-0Z2do2R7FOdBx5_2W8Z7w,51206
+marsilea/base.py,sha256=CmzuwFu0JzgkNpPdI1SqAnkUxINShjT73hrJpksKjhE,46872
 marsilea/dataset.py,sha256=Qh8k1DhTiwP_Me709CkpNwRaYLDzlenRTIk0U6D58_g,4631
 marsilea/dendrogram.py,sha256=Ung43zseybZKzTEvH5P_ge3WGfsr7i7qsX7YEVDlC74,15590
 marsilea/exceptions.py,sha256=wN5ElUZxuaJKSnnwWdkNx6P-Oc16dzSuaRPbRKWIBEM,1046
-marsilea/heatmap.py,sha256=UhRcBFhx1JKrtndZPvQCDaiMt8Pb314PT1BtL-JndCY,4208
+marsilea/heatmap.py,sha256=8Wo1NxFTBp1a7NOISmer0yQYWWgf51Xsvjav1h1vTYk,4316
 marsilea/layers.py,sha256=puXLlGGpEqAzaTqadpgpsYmIDPH33WyyHIuysRSqFZQ,12163
 marsilea/layout.py,sha256=yNuGvIDfWjbCksQZO-4aUWSA78LJwBBKF5Z5cthC6fM,39741
 marsilea/upset.py,sha256=JnqV9HYYpoeLt-6yMy0HN_PUSgV-ENasf6vq6HsX3cI,30393
@@ -25,7 +25,7 @@ marsilea/plotter/text.py,sha256=6S4mnAxLJLMkduKiyor03lPd86oTOJ5TojVREA9oU6s,3746
 oncoprinter/__init__.py,sha256=efshcAD1h9s-NVJj4HLU9-hXc_LtTeIrNYqLHl-sm_g,106
 oncoprinter/core.py,sha256=5KPnKW5ivlxPp14uJd0OtfTv-pXV2UEym8EbII2VCcw,11846
 oncoprinter/preset.py,sha256=mBk2tFCqoTj_1ZZKRYuv4j2I3NTBa6Swc9wjzbmxRVw,8238
-marsilea-0.4.8.dist-info/METADATA,sha256=NAJopsdO64Z8Mtl5HQjEzZ2wm51Jv2eCjkD7UhKOqQc,6866
-marsilea-0.4.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-marsilea-0.4.8.dist-info/licenses/LICENSE,sha256=2TLD8FnLJqXzg8YBRs7W3VZBwfWfp4ArDfBl-rn96Qc,1074
-marsilea-0.4.8.dist-info/RECORD,,
+marsilea-0.5.0.dist-info/METADATA,sha256=lC8_51jHvIq0C6-k536cXZzsNGvYrx3ZqnOnOR74s2M,7023
+marsilea-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+marsilea-0.5.0.dist-info/licenses/LICENSE,sha256=RhHHDuP61qzKmfHtOQUVLZfCgMkKx9PXzxzkLtmAjHo,1078
+marsilea-0.5.0.dist-info/RECORD,,

{marsilea-0.4.8.dist-info → marsilea-0.5.0.dist-info}/licenses/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Mr-Milk
+Copyright (c) 2025 Yimin Zheng
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal