From ad299fbe0c9afa8a33db9c893cbc3f9a99c04bf0 Mon Sep 17 00:00:00 2001 From: Jacobluke- Date: Sat, 2 Mar 2024 13:04:16 +0800 Subject: [PATCH] Edit on docs Adding description for DABEST in Getting-Started --- nbs/01-getting_started.ipynb | 39 +++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/nbs/01-getting_started.ipynb b/nbs/01-getting_started.ipynb index ac0e884b..06e4aa61 100644 --- a/nbs/01-getting_started.ipynb +++ b/nbs/01-getting_started.ipynb @@ -7,11 +7,48 @@ "source": [ "# Getting Started\n", "\n", - "> Requirements and installation of dabest.\n", + "> Requirements and installation of DABEST.\n", "\n", "- order: 1" ] }, + { + "cell_type": "markdown", + "id": "55571169", + "metadata": {}, + "source": [ + "## Introduction" + ] + }, + { + "cell_type": "markdown", + "id": "4894b0f6", + "metadata": {}, + "source": [ + "DABEST is a package for **D**ata **A**nalysis with **B**ootstrapped **EST**imation\n", + "\n", + "[Estimation statistics](https://en.wikipedia.org/wiki/Estimation_statistics) is a simple framework that avoids the [pitfalls](https://www.nature.com/articles/nmeth.3288) of significance testing. It uses familiar statistical concepts: means, mean differences, and error bars. More importantly, it focuses on the effect size of one’s experiment/intervention, as opposed to a false dichotomy engendered by *P* values." + ] + }, + { + "cell_type": "markdown", + "id": "928e463e", + "metadata": {}, + "source": [ + "An estimation plot has two key features.\n", + "\n", + "1. It **presents all datapoints** as a swarmplot, which orders each point to display the underlying distribution.\n", + "2. It presents the **effect size** as a **bootstrap 95% confidence interval** on a **separate but aligned axes**." + ] + }, + { + "cell_type": "markdown", + "id": "28096cfa", + "metadata": {}, + "source": [ + "DABEST powers [estimationstats.com](estimationstats.com), allowing everyone access to high-quality estimation plots." + ] + }, { "cell_type": "markdown", "id": "d1d5cb1a",