Skip to content

Commit 5403640

Browse files
committed
First changes on documentation
1 parent 65660da commit 5403640

3 files changed

Lines changed: 14 additions & 12 deletions

File tree

nbs/01-getting_started.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
"source": [
7171
"2. Using Github\n",
7272
"\n",
73-
"Clone the [DABEST-python repo](https://github.com/ACCLAB/DABEST-python) locally (see instructions [here] (https://help.github.com/articles/cloning-a-repository/).\n",
73+
"Clone the [DABEST-python repo](https://github.com/ACCLAB/DABEST-python) locally (see instructions [here](https://help.github.com/articles/cloning-a-repository/)).\n",
7474
"\n",
7575
"Then, navigate to the cloned repo in the command line and run\n",
7676
"\n",

nbs/02-about.ipynb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
"\n",
6767
" * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.\n",
6868
"\n",
69+
"<div style=\"padding: 15px; border: 1px solid transparent; border-color: transparent; margin-bottom: 20px; border-radius: 4px; color: #8a6d3b;; background-color: #fcf8e3; border-color: #faebcc;\">\n",
6970
"NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY\n",
7071
"THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\n",
7172
"CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n",
@@ -77,7 +78,8 @@
7778
"BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER\n",
7879
"IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n",
7980
"ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\n",
80-
"POSSIBILITY OF SUCH DAMAGE.\n"
81+
"POSSIBILITY OF SUCH DAMAGE.\n",
82+
"</div>\n"
8183
]
8284
},
8385
{

nbs/read_me.ipynb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@
6262
"\n",
6363
"DABEST is a package for **D**ata **A**nalysis using **B**ootstrap-Coupled **EST**imation.\n",
6464
"\n",
65-
"[Estimation statistics](https://en.wikipedia.org/wiki/Estimation_statistics) is a [simple framework](https://thenewstatistics.com/itns/) 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.\n",
65+
"[Estimation statistics](https://en.wikipedia.org/wiki/Estimation_statistics) are a [simple framework](https://thenewstatistics.com/itns/) that avoids the [pitfalls](https://www.nature.com/articles/nmeth.3288) of significance testing. It employs familiar statistical concepts such as means, mean differences, and error bars. More importantly, it focuses on the effect size of one's experiment or intervention, rather than succumbing to a false dichotomy engendered by *P* values.\n",
6666
"\n",
67-
"An estimation plot has two key features.\n",
67+
"An estimation plot comprises two key features.\n",
6868
"\n",
69-
"1. It presents all datapoints as a swarmplot, which orders each point to display the underlying distribution.\n",
69+
"1. It presents all data points as a swarm plot, ordering each point to display the underlying distribution.\n",
7070
"\n",
71-
"2. It presents the effect size as a **bootstrap 95% confidence interval** on a **separate but aligned axes**.\n",
71+
"2. It illustrates the effect size as a **bootstrap 95% confidence interval** on a **separate but aligned axis**.\n",
7272
"\n",
7373
"![The five kinds of estimation plots](showpiece.png \"The five kinds of estimation plots.\")\n",
7474
"\n",
@@ -116,7 +116,7 @@
116116
"import pandas as pd\n",
117117
"import dabest\n",
118118
"\n",
119-
"# Load the iris dataset. Requires internet access.\n",
119+
"# Load the iris dataset. This step requires internet access.\n",
120120
"iris = pd.read_csv(\"https://github.com/mwaskom/seaborn-data/raw/master/iris.csv\")\n",
121121
"\n",
122122
"# Load the above data into `dabest`.\n",
@@ -172,13 +172,13 @@
172172
"metadata": {},
173173
"source": [
174174
"### A wish list for new features\n",
175-
"Currently, DABEST offers functions to handle data traditionally analyzed with Student's paired and unpaired t-tests. It also offers plots for multiplexed versions of these, and the estimation counterpart to a 1-way analysis of variance (ANOVA), the shared-control design. While these five functions execute a large fraction of common biomedical data analyses, there remain three others: 2-way data, time-series group data, and proportional data. We aim to add these new functions to both the R and Python libraries.\n",
175+
"Currently, DABEST offers functions to handle data traditionally analyzed with Student's paired and unpaired t-tests. It also provides plots for multiplexed versions of these, and the estimation counterpart to a 1-way analysis of variance (ANOVA), known as the shared-control design. While these five functions cover a large fraction of common biomedical data analyses, three others are yet to be implemented: 2-way data, time-series group data, and proportional data. We aim to add these new functions to both the R and Python libraries.\n",
176176
"\n",
177-
"- In many experiments, four groups are investigate to isolate an interaction, for example: a genotype × drug effect. Here, wild-type and mutant animals are each subjected to drug or sham treatments; the data are traditionally analysed with a 2×2 ANOVA. We have received requests by email, Twitter, and GitHub to implement an estimation counterpart to the 2-way ANOVA. To do this, we will implement $\\Delta\\Delta$ plots, in which the difference of means ($\\Delta$) of two groups is subtracted from a second two-group $\\Delta$. **Implemented in v2023.02.14.**\n",
177+
"- In many experiments, four groups are investigated to isolate an interaction, for example: a genotype × drug effect. Here, wild-type and mutant animals are each subjected to drug or sham treatments; the data are traditionally analysed with a 2×2 ANOVA. We have received requests via email, Twitter, and GitHub to implement an estimation counterpart to the 2-way ANOVA. To address this, we will implement $\\Delta\\Delta$ plots, in which the difference of means ($\\Delta$) of two groups is subtracted from a second two-group $\\Delta$. **Implemented in v2023.02.14.**\n",
178178
"\n",
179179
"- Currently, DABEST can analyse multiple paired data in a single plot, and multiple groups with a common, shared control. However, a common design in biomedical science is to follow the same group of subjects over multiple, successive time points. An estimation plot for this would combine elements of the two other designs, and could be used in place of a repeated-measures ANOVA. **Implemented in v2023.02.14**\n",
180180
"\n",
181-
"- We have observed that proportional data are often analyzed in neuroscience and other areas of biomedical research. However, compared to other data types, the charts are frequently impoverished: often, they omit error bars, sample sizes, and even P values—let alone effect sizes. We would like DABEST to feature proportion charts, with error bars and a curve for the distribution of the proportional differences. **Implemented in v2023.02.14**\n",
181+
"- We have observed that proportional data are often analyzed in neuroscience and other areas of biomedical research. However, compared to other data types, the charts are frequently impoverished: often omitting error bars, sample sizes, and even P values—let alone effect sizes. We would like DABEST to feature proportion charts, with error bars and a curve for the distribution of the proportional differences. **Implemented in v2023.02.14**\n",
182182
"\n",
183183
"We encourage contributions for the above features. "
184184
]
@@ -195,9 +195,9 @@
195195
"\n",
196196
"## Testing\n",
197197
"\n",
198-
"To test DABEST, you will need to install [pytest](https://docs.pytest.org/en/latest).\n",
198+
"To test DABEST, you need to install [pytest](https://docs.pytest.org/en/latest).\n",
199199
"\n",
200-
"Run `pytest` in the root directory of the source distribution. This runs the test suite in the folder `dabest/tests`. The test suite will ensure that the bootstrapping functions and the plotting functions perform as expected.\n",
200+
"Run `pytest` in the root directory of the source distribution. This runs the test suite in the folder `dabest/tests`. The test suite ensures that the bootstrapping functions and the plotting functions perform as expected.\n",
201201
"\n",
202202
"\n",
203203
"## DABEST in other languages\n",

0 commit comments

Comments
 (0)