Add symlog scales

closes #702
has2k1 · Aug 4, 2023 · 94d697f · 94d697f
1 parent 5bc4ff6
commit 94d697f
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 0 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -355,6 +355,7 @@ Position scales
    scale_x_log10
    scale_x_reverse
    scale_x_sqrt
+   scale_x_symlog
    scale_x_timedelta
    scale_y_continuous
    scale_y_date
@@ -363,6 +364,7 @@ Position scales
    scale_y_log10
    scale_y_reverse
    scale_y_sqrt
+   scale_y_symlog
    scale_y_timedelta
 
 

diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -14,6 +14,11 @@ API Changes
 
 New
 ***
+
+- Added symmetric logarithm transformation scales
+  :class:`~plotnine.scales.scale_x_symlog` and
+  :class:`~plotnine.scales.scale_x_symlog`
+
 - Gained themeables
 
   - :meth:`~plotnine.themes.themeable.plot_margin_left`

diff --git a/plotnine/__init__.py b/plotnine/__init__.py
@@ -214,6 +214,7 @@
     "scale_x_log10",
     "scale_x_reverse",
     "scale_x_sqrt",
+    "scale_x_symlog",
     "scale_x_timedelta",
     "scale_y_continuous",
     "scale_y_date",
@@ -222,6 +223,7 @@
     "scale_y_log10",
     "scale_y_reverse",
     "scale_y_sqrt",
+    "scale_y_symlog",
     "scale_y_timedelta",
     "xlim",
     "ylim",

diff --git a/plotnine/scales/__init__.py b/plotnine/scales/__init__.py
@@ -127,6 +127,7 @@
     scale_x_log10,
     scale_x_reverse,
     scale_x_sqrt,
+    scale_x_symlog,
     scale_x_timedelta,
     scale_y_continuous,
     scale_y_date,  # pyright: ignore
@@ -135,6 +136,7 @@
     scale_y_log10,
     scale_y_reverse,
     scale_y_sqrt,
+    scale_y_symlog,
     scale_y_timedelta,
 )
 
@@ -236,6 +238,7 @@
     "scale_x_log10",
     "scale_x_reverse",
     "scale_x_sqrt",
+    "scale_x_symlog",
     "scale_x_timedelta",
     "scale_y_continuous",
     "scale_y_date",
@@ -244,6 +247,7 @@
     "scale_y_log10",
     "scale_y_reverse",
     "scale_y_sqrt",
+    "scale_y_symlog",
     "scale_y_timedelta",
     # limits
     "xlim",

diff --git a/plotnine/scales/scale_xy.py b/plotnine/scales/scale_xy.py
@@ -426,3 +426,29 @@ class scale_y_reverse(scale_y_continuous):
     """
 
     _trans = "reverse"
+
+
+@document
+class scale_x_symlog(scale_x_continuous):
+    """
+    Continuous x position symmetric logarithm transformed scale
+
+    Parameters
+    ----------
+    {superclass_parameters}
+    """
+
+    _trans = "symlog"
+
+
+@document
+class scale_y_symlog(scale_y_continuous):
+    """
+    Continuous y position symmetric logarithm transformed scale
+
+    Parameters
+    ----------
+    {superclass_parameters}
+    """
+
+    _trans = "symlog"