documentation

markur4 · Nov 28, 2023 · cb2107a · cb2107a
1 parent 115a00f
commit cb2107a
Show file tree

Hide file tree

Showing 4 changed files with 459 additions and 11 deletions.
diff --git a/How_To_Use/plotting.ipynb b/How_To_Use/plotting.ipynb
@@ -4,7 +4,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Plotting"
+    "# Plotting\n",
+    "Here we explain the low-end interface for plotting with plotastic."
    ]
   },
   {
@@ -171,7 +172,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Reminder: Multiplots are pre-defined plotting functions!\n",
+    "### Reminder: Use pre-defined MultiPlots!\n",
     "Before we go through the low-end plotting functionality, note that we\n",
     "have high-end plotting functionality that is pre-defined for you. See\n",
     "multiplots for a demonstration of all of these functions!\n"

diff --git a/How_To_Use/plotting_multiplots.ipynb b/How_To_Use/plotting_multiplots.ipynb
diff --git a/README.md b/README.md
@@ -657,14 +657,15 @@ classDiagram
 [//]:<=========================================================================>
 
 ## Docs 💡
-1. [Quick Example: FMRI Dataset](https://github.com/markur4/plotastic/blob/main/How_To_Use/quick_example_fmri.ipynb)
-2. [Switch Dimensions](https://github.com/markur4/plotastic/blob/main/How_To_Use/dimensions.ipynb)
-3. [Plotting](https://github.com/markur4/plotastic/blob/main/How_To_Use/plotting.ipynb)
+1. [Quick Example: FMRI Dataset](https://github.com/markur4/plotastic/blob/main/HOW_TO_USE/quick_example_fmri.ipynb)
+2. [Switch Dimensions](https://github.com/markur4/plotastic/blob/main/HOW_TO_USE/dimensions.ipynb)
+3. [Plotting](https://github.com/markur4/plotastic/blob/main/HOW_TO_USE/plotting.ipynb)
+4. [Plotting: MultiPlots](https://github.com/markur4/plotastic/blob/main/HOW_TO_USE/plotting_multiplots.ipynb)
 
 ## Quick Example 💨
 
 [//]:<=========================================================================>
-[//]:<.ipynb Notebooks taken from How_To_Use.ipynb>
+[//]:<.ipynb Notebooks taken from HOW_TO_USE.ipynb>
 [//]:<Converted using:>
 [//]:<jupyter nbconvert --to markdown your_notebook.ipynb>
 
@@ -745,7 +746,7 @@ DA.catplot(alpha=0.3) # Works with *kwargs of seaborn.catplot()
 
 
 
-![How_To_Use/quick_example_fmri_files/quick_example_fmri_7_0.png](https://raw.githubusercontent.com/markur4/plotastic/main/How_To_Use/quick_example_fmri_files/quick_example_fmri_7_0.png)
+![HOW_TO_USE/quick_example_fmri_files/quick_example_fmri_7_0.png](https://raw.githubusercontent.com/markur4/plotastic/main/HOW_TO_USE/quick_example_fmri_files/quick_example_fmri_7_0.png)
 
 
 
@@ -1034,7 +1035,7 @@ plt.savefig("example.png", dpi=200, bbox_inches="tight")
 
 
 
-![How_To_Use/quick_example_fmri_files/example.png](https://raw.githubusercontent.com/markur4/plotastic/main/How_To_Use/quick_example_fmri_files/example.png)
+![HOW_TO_USE/quick_example_fmri_files/example.png](https://raw.githubusercontent.com/markur4/plotastic/main/HOW_TO_USE/quick_example_fmri_files/example.png)
 
 
 

diff --git a/src/plotastic/plotting/multiplot.py b/src/plotastic/plotting/multiplot.py
@@ -74,6 +74,7 @@ def plot_box_strip(
         subplot_kws: dict = dict(),
         box_kws: dict = dict(),
         strip_kws: dict = dict(),
+        legend_kws: dict = dict(),
     ) -> "MultiPlot | DataAnalysis":
         """A boxplot with a stripplott (scatter) on top
 
@@ -119,8 +120,8 @@ def plot_box_strip(
             jitter=0.2,  #' How far datapoints of one group scatter across the x-axis
             zorder=front,
             ### Marker Style
-            alpha=marker_alpha,
             size=marker_size,
+            alpha=marker_alpha,
             # color="none",
             edgecolor="white",
             linewidth=thin,  #' Edge width of the marker
@@ -138,7 +139,7 @@ def plot_box_strip(
         )
 
         if legend and self.dims.hue:
-            self.edit_legend()
+            self.edit_legend(**legend_kws)
 
         return self
 
@@ -150,6 +151,7 @@ def plot_box_swarm(
         subplot_kws: dict = dict(),
         box_kws: dict = dict(),
         swarm_kws: dict = dict(),
+        legend_kws: dict = dict(),
     ) -> "MultiPlot | DataAnalysis":
         """A boxplot with a stripplott (scatter) on top
 
@@ -217,7 +219,7 @@ def plot_box_swarm(
         )
 
         if legend and self.dims.hue:
-            self.edit_legend()
+            self.edit_legend(**legend_kws)
 
         return self