Fixed contrast axis issue with float_contrast, and updated readme and tutorials

> Fixed float contrast =True, contrast axis xlim
> Updated Tutorials
> Updated readme

Author: JAnns98

README.md

@@ -40,13 +40,28 @@ performance improvements. It’s a big one!
 
 5.  **Other Visualization Improvements**:
 
-    - **Raw, Contrast, and Summary bars**: We added bars highlighting
-      the various groups’ differences. These bars can be customized to
-      suit the user’s needs. Raw and contrast bars are provided by
-      default, summary bars can be added by the user. See the relevant
-      sections in the [Plot
-      Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for
-      more details.
+    - **Raw, Contrast, and Summary bars**: Our visualization package now
+      includes three types of customizable bars to enhance data
+      interpretation:
+
+      - **Raw Bars**: Colored rectangles that extend from the zero line
+        to the mean of each group’s raw data. These bars visually
+        highlight the central tendency of the raw data.
+
+      - **Contrast Bars**: Similar to raw bars, these highlight the
+        effect size difference between two groups (typically test and
+        control) in the contrast axis. They provide a visual
+        representation of the differences between groups.
+
+      - **Summary Bars**: Optional horizontal bars that can be added to
+        emphasize a specific effect size across the entire contrast
+        axis. Unlike raw and contrast bars, these span horizontally and
+        are not displayed by default.
+
+        By default, plots show raw and contrast bars. Users can
+        customize these bars and add summary bars as needed. For
+        detailed customization instructions, please refer to the [Plot
+        Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial.
 
     - **Tighter spacing in Delta-Delta and Mini-Meta Plots**: We have
       adjusted the spacing of delta-delta and mini-meta plots to reduce
@@ -172,7 +187,7 @@ allowing everyone access to high-quality estimation plots.
 
 ## Installation
 
-This package is tested on Python 3.10 and onwards. It is highly
+This package is tested on Python 3.11 and onwards. It is highly
 recommended to download the [Anaconda
 distribution](https://www.continuum.io/downloads) of Python in order to
 obtain the dependencies easily.

dabest/misc_tools.py

@@ -1236,7 +1236,7 @@ def set_xaxis_ticks_and_lims(
         if float_contrast:
             contrast_axes.set_xlim(0.5, 1.5)
 
-        if show_delta2:
+        elif show_delta2:
             if show_pairs:
                 rawdata_axes.set_xlim(-0.375, 4.75)
             else:

dabest/plotter.py

@@ -449,7 +449,7 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
                                                                   else effectsize_df.delta_delta.difference if show_delta2
                                                                   else None),
         )
-    
+
     ## Make sure the contrast_axes x-lims match the rawdata_axes xlims,
     ## and add an extra violinplot tick for delta-delta plot.
     ## Name is xaxis but it is actually y-axis for horizontal plots

nbs/API/misc_tools.ipynb

@@ -1289,7 +1289,7 @@
     "        if float_contrast:\n",
     "            contrast_axes.set_xlim(0.5, 1.5)\n",
     "\n",
-    "        if show_delta2:\n",
+    "        elif show_delta2:\n",
     "            if show_pairs:\n",
     "                rawdata_axes.set_xlim(-0.375, 4.75)\n",
     "            else:\n",

nbs/API/plotter.ipynb

@@ -506,7 +506,7 @@
     "                                                                  else effectsize_df.delta_delta.difference if show_delta2\n",
     "                                                                  else None),\n",
     "        )\n",
-    "    \n",
+    "\n",
     "    ## Make sure the contrast_axes x-lims match the rawdata_axes xlims,\n",
     "    ## and add an extra violinplot tick for delta-delta plot.\n",
     "    ## Name is xaxis but it is actually y-axis for horizontal plots\n",

nbs/read_me.ipynb

@@ -40,8 +40,13 @@
     "4. **Gridkey**: Users can now represent experimental labels in a ‘gridkey’ table. This can be accessed with the `gridkey` parameter in the `plot()` method. See the gridkey section in the [Plot Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for more details.\n",
     "\n",
     "5. **Other Visualization Improvements**:\n",
-    "   - **Raw, Contrast, and Summary bars**: We added bars highlighting the various groups' differences. These bars can be customized to suit the user’s needs. Raw and contrast bars are provided by default, summary bars can be added by the user. See the relevant sections in the [Plot Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for more details.\n",
-    "  \n",
+    "   - **Raw, Contrast, and Summary bars**: Our visualization package now includes three types of customizable bars to enhance data interpretation:\n",
+    "     - **Raw Bars**: Colored rectangles that extend from the zero line to the mean of each group's raw data. These bars visually highlight the central tendency of the raw data.\n",
+    "     - **Contrast Bars**: Similar to raw bars, these highlight the effect size difference between two groups (typically test and control) in the contrast axis. They provide a visual representation of the differences between groups.\n",
+    "     - **Summary Bars**: Optional horizontal bars that can be added to emphasize a specific effect size across the entire contrast axis. Unlike raw and contrast bars, these span horizontally and are not displayed by default.\n",
+    "\n",
+    "          By default, plots show raw and contrast bars. Users can customize these bars and add summary bars as needed. For detailed customization instructions, please refer to the [Plot Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial.\n",
+    "\n",
     "   - **Tighter spacing in Delta-Delta and Mini-Meta Plots**: We have adjusted the spacing of delta-delta and mini-meta plots to reduce whitespace. The new format brings the overall effect size closer to the two-groups effect sizes. In addition, delta-delta plots now have a gap in the zero line to separate the delta-delta from the ∆ effect sizes.\n",
     "\n",
     "   - **Delta-Delta Effect Sizes for Proportion Plots**: In addition to continuous data, delta-delta plots now support binary data (proportions). This means that 2-way designs for binary outcomes can be analyzed with DABEST.\n",
@@ -118,7 +123,7 @@
    "source": [
     "## Installation\n",
     "\n",
-    "This package is tested on Python 3.10 and onwards.\n",
+    "This package is tested on Python 3.11 and onwards.\n",
     "It is highly recommended to download the [Anaconda distribution](https://www.continuum.io/downloads) of Python in order to obtain the dependencies easily.\n",
     "\n",
     "You can install this package via `pip`.\n",
@@ -232,12 +237,6 @@
     "\n",
     "DABEST is also available in R ([dabestr](https://github.com/ACCLAB/dabestr)) and Matlab ([DABEST-Matlab](https://github.com/ACCLAB/DABEST-Matlab)).\n"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "7106313a",
-   "metadata": {},
-   "source": []
   }
  ],
  "metadata": {