Merge pull request #179 from ACCLAB/patch-docstring-fix

Patch docstring fix
ACCLAB · Sep 24, 2024 · 360fdc3 · 360fdc3
2 parents f8fa263 + 8e278d1
commit 360fdc3
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
 [![minimal Python
-version](https://img.shields.io/badge/Python%3E%3D-3.8-6666ff.svg)](https://www.anaconda.com/distribution/)
+version](https://img.shields.io/badge/Python%3E%3D-3.9-6666ff.svg)](https://www.anaconda.com/distribution/)
 [![PyPI
 version](https://badge.fury.io/py/dabest.svg)](https://badge.fury.io/py/dabest)
 [![Downloads](https://img.shields.io/pepy/dt/dabest.svg)](https://pepy.tech/project/dabest)

diff --git a/dabest/_stats_tools/effsize.py b/dabest/_stats_tools/effsize.py
@@ -223,7 +223,7 @@ def cohens_h(control:list|tuple|np.ndarray,
             )->float:
     '''
     Computes Cohen's h for test v.s. control.
-    See [here](https://en.wikipedia.org/wiki/Cohen%27s_h for reference.)
+    See [here](https://en.wikipedia.org/wiki/Cohen%27s_h) for reference.
     
     `Notes`:
     

diff --git a/nbs/API/effsize.ipynb b/nbs/API/effsize.ipynb
@@ -301,7 +301,7 @@
     "            )->float:\n",
     "    '''\n",
     "    Computes Cohen's h for test v.s. control.\n",
-    "    See [here](https://en.wikipedia.org/wiki/Cohen%27s_h for reference.)\n",
+    "    See [here](https://en.wikipedia.org/wiki/Cohen%27s_h) for reference.\n",
     "    \n",
     "    `Notes`:\n",
     "    \n",

diff --git a/nbs/API/plotter.ipynb b/nbs/API/plotter.ipynb
@@ -648,6 +648,52 @@
     "    # Return the figure.\n",
     "    return fig"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7355251f",
+   "metadata": {},
+   "source": [
+    "For details on how to control the aesthetic of the generated estimation plot by modifying the **plot_kwargs**, please refer to [Controlling Plot Aesthetics](../tutorials/06-plot_aesthetics.ipynb)\n",
+    "\n",
+    "- **effectsize_df**: A `dabest` `EffectSizeDataFrame` object.\n",
+    "- **plot_kwargs**:\n",
+    "    - color_col=None\n",
+    "    - raw_marker_size=6, es_marker_size=9,\n",
+    "    - swarm_label=None, contrast_label=None, delta2_label=None,\n",
+    "    - swarm_ylim=None, contrast_ylim=None, delta2_ylim=None,\n",
+    "    - custom_palette=None, swarm_desat=0.5, halfviolin_desat=1,\n",
+    "    - halfviolin_alpha=0.8,\n",
+    "    - face_color = None,\n",
+    "    - bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None,\n",
+    "    - ci=None, ci_type='bca', err_color=None,\n",
+    "    - float_contrast=True,\n",
+    "    - show_pairs=True,\n",
+    "    - show_delta2=True,\n",
+    "    - group_summaries=None,\n",
+    "    - group_summaries_offset=0.1,\n",
+    "    - fig_size=None,\n",
+    "    - dpi=100,\n",
+    "    - ax=None,\n",
+    "    - gridkey_rows=None,\n",
+    "    - swarmplot_kwargs=None,\n",
+    "    - violinplot_kwargs=None,\n",
+    "    - slopegraph_kwargs=None,\n",
+    "    - sankey_kwargs=None,\n",
+    "    - reflines_kwargs=None,\n",
+    "    - group_summary_kwargs=None,\n",
+    "    - egend_kwargs=None,\n",
+    "    - title=None, fontsize_title=16,\n",
+    "    - fontsize_rawxlabel=12, fontsize_rawylabel=12,\n",
+    "    - fontsize_contrastxlabel=12, fontsize_contrastylabel=12,\n",
+    "    - fontsize_delta2label=12"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f1cc27d4",
+   "metadata": {},
+   "source": []
   }
  ],
  "metadata": {

diff --git a/nbs/read_me.ipynb b/nbs/read_me.ipynb
@@ -13,7 +13,7 @@
    "id": "5164f940",
    "metadata": {},
    "source": [
-    "[![minimal Python version](https://img.shields.io/badge/Python%3E%3D-3.8-6666ff.svg)](https://www.anaconda.com/distribution/)\n",
+    "[![minimal Python version](https://img.shields.io/badge/Python%3E%3D-3.9-6666ff.svg)](https://www.anaconda.com/distribution/)\n",
     "[![PyPI version](https://badge.fury.io/py/dabest.svg)](https://badge.fury.io/py/dabest)\n",
     "[![Downloads](https://img.shields.io/pepy/dt/dabest.svg\n",
     ")](https://pepy.tech/project/dabest)\n",

diff --git a/nbs/tutorials/03-proportion_plot.ipynb b/nbs/tutorials/03-proportion_plot.ipynb
@@ -452,7 +452,7 @@
     "To generate a proportion plot, the **dabest** library features two effect sizes:\n",
     "\n",
     "  - the mean difference (``mean_diff``)\n",
-    "  - [Cohen's h](https://en.wikipedia.org/wiki/Cohen%27s_h) (``cohens_h``)\n",
+    "  - [Cohen's h](https://en.wikipedia.org/wiki/Cohen's_h) (`cohens＿h`)\n",
     "\n",
     "These are attributes of the ``Dabest`` object."
    ]

diff --git a/nbs/tutorials/04-mini_meta_delta.ipynb b/nbs/tutorials/04-mini_meta_delta.ipynb
@@ -47,7 +47,7 @@
     "\n",
     "Additionally, be aware that as of v2023.02.14, DABEST can only compute weighted effect size *for mean difference only*, and not for standardized measures such as Cohen's *d*.\n",
     "\n",
-    "For more information on meta-analysis, please refer to Chapter 10 of the Cochrane handbook: https://training.cochrane.org/handbook/current/chapter-10\n"
+    "For more information on meta-analysis, please refer to [Chapter 10 of the Cochrane handbook](https://training.cochrane.org/handbook/current/chapter-10)"
    ]
   },
   {