updated readme

README.Rmd

@@ -24,6 +24,8 @@ knitr::opts_chunk$set(
 [![CodeFactor](https://www.codefactor.io/repository/github/qddyy/LearnNonparam/badge)](https://www.codefactor.io/repository/github/qddyy/LearnNonparam)
 [![R CMD check](https://github.com/qddyy/LearnNonparam/workflows/R-CMD-check/badge.svg)](https://github.com/qddyy/LearnNonparam/actions)
 
+## Overview
+
 This package implements most of the tests in chapters 1-5 of [@Higgins2003](#references).
 
 It uses [R6](https://cran.r-project.org/package=R6) for clean OO-design and [arrangements](https://cran.r-project.org/package=arrangements) for fast generation of permutations, as well as [ggplot2](https://cran.r-project.org/package=ggplot2) to draw pretty graphs.
@@ -82,9 +84,7 @@ There is also support for chaining method calls, which means that you can do thi
 t <- pmt(...)$feed(...)$print(...)$plot(...)
 ```
 
-In addition, a progress bar will appear when calculating the permutation distribution if R is used interactively, which can be turned off with `options(pmt_progress = FALSE)`.
-
-## Help
+## Tips
 
 - Explore `?PermuTest` (all tests' base class) for all available methods and attributes.
 
@@ -93,4 +93,8 @@ In addition, a progress bar will appear when calculating the permutation distrib
     pmts()
     ```
 
+- Use `options(pmt_progress = FALSE)` to disable the progress bar. 
+
+    (By default, a progress bar will appear when calculating the permutation distribution if R is used interactively)
+
 ## References

README.md

@@ -11,6 +11,8 @@ size](https://img.shields.io/github/languages/code-size/qddyy/LearnNonparam.svg)
 [![R CMD
 check](https://github.com/qddyy/LearnNonparam/workflows/R-CMD-check/badge.svg)](https://github.com/qddyy/LearnNonparam/actions)
 
+## Overview
+
 This package implements most of the tests in chapters 1-5 of [Higgins
 (2003)](#references).
 
@@ -61,17 +63,17 @@ library(LearnNonparam)
 
   ``` r
   t$p_value
-  #> [1] 0.000212
+  #> [1] 0.000171
 
   t$print()
   #> 
   #>       Two Sample Wilcoxon Test 
   #> 
-  #> scoring: rank    type: permu    method: default    
-  #> statistic = 536, p-value = 0.000212, 
-  #> alternative hypothesis: greater 
-  #> estimate: 0.9600879 
-  #> 95 percent confidence interval: 0.4694747 1.4489994
+  #> scoring: rank    type: permu(1e+06)    method: default
+  #> statistic = 537, p-value = 0.000171
+  #> alternative hypothesis: greater
+  #> estimate: 1.160377
+  #> 95 percent confidence interval: 0.5748014 1.9411487
 
   t$plot(binwidth = 1)
   ```
@@ -84,7 +86,7 @@ library(LearnNonparam)
   t$type <- "approx"
 
   t$p_value
-  #> [1] 0.0003434111
+  #> [1] 0.0003109988
   ```
 
 There is also support for chaining method calls, which means that you
@@ -94,11 +96,7 @@ can do things like
 t <- pmt(...)$feed(...)$print(...)$plot(...)
 ```
 
-In addition, a progress bar will appear when calculating the permutation
-distribution if R is used interactively, which can be turned off with
-`options(pmt_progress = FALSE)`.
-
-## Help
+## Tips
 
 - Explore `?PermuTest` (all tests’ base class) for all available methods
   and attributes.
@@ -138,6 +136,11 @@ distribution if R is used interactively, which can be turned off with
 
   </div>
 
+- Use `options(pmt_progress = FALSE)` to disable the progress bar.
+
+  (By default, a progress bar will appear when calculating the
+  permutation distribution if R is used interactively)
+
 ## References
 
 <div id="refs" class="references csl-bib-body hanging-indent">