minor doc fix

IndrajeetPatil · Oct 17, 2020 · 36ca0b4 · 36ca0b4 · lintr-bot · Oct 17, 2020
1 parent faeb154
commit 36ca0b4
Show file tree

Hide file tree

Showing 19 changed files with 136 additions and 112 deletions.
diff --git a/R/bf_oneway_anova.R b/R/bf_oneway_anova.R
@@ -1,4 +1,4 @@
-#' @title Bayesian one-way analysis of variance (ANOVA)
+#' @title Bayes Factor for one-way analysis of variance (ANOVA)
 #' @name bf_oneway_anova
 #'
 #' @importFrom BayesFactor anovaBF

diff --git a/R/bf_ttest.R b/R/bf_ttest.R
@@ -12,7 +12,7 @@
 #' @param test.value A number specifying the value of the null hypothesis
 #'   (Default: `0`).
 #' @param output If `"expression"`, will return expression with statistical
-#'   details, while `"dataframe"` (default) will return a dataframe containing the
+#'   details, while `"dataframe"` will return a dataframe containing the
 #'   results.
 #'
 #' @importFrom BayesFactor ttestBF

diff --git a/README.Rmd b/README.Rmd
@@ -82,6 +82,15 @@ remotes::install_github(
 
 # Summary of available tests
 
+Behind the curtains, `tidyBF` provides an easier syntax to marry functionalities
+provided by the following two packages in a unified framework:
+
+  - [`BayesFactor`](https://richarddmorey.github.io/BayesFactor/) : for
+    hypothesis testing
+
+  - [`bayestestR`](https://easystats.github.io/bayestestR/): for posterior
+    estimation
+
 Analysis | Function | Hypothesis testing | Estimation
 ------------------ | ---------- | ---------- | ---------
 (one/two-sample) t-test | `bf_ttest` | <font color="green">Yes</font> | <font color="green">Yes</font>

diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ Status](https://ci.appveyor.com/api/projects/status/github/IndrajeetPatil/tidyBF
 [![Project Status: Active - The project has reached a stable, usable
 state and is being actively
 developed.](http://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![Last-changedate](https://img.shields.io/badge/last%20change-2020--10--16-yellowgreen.svg)](https://github.com/IndrajeetPatil/tidyBF/commits/master)
+[![Last-changedate](https://img.shields.io/badge/last%20change-2020--10--17-yellowgreen.svg)](https://github.com/IndrajeetPatil/tidyBF/commits/master)
 [![minimal R
 version](https://img.shields.io/badge/R%3E%3D-3.6.0-6666ff.svg)](https://cran.r-project.org/)
 [![Coverage
@@ -75,6 +75,16 @@ remotes::install_github(
 
 # Summary of available tests
 
+Behind the curtains, `tidyBF` provides an easier syntax to marry
+functionalities provided by the following two packages in a unified
+framework:
+
+-   [`BayesFactor`](https://richarddmorey.github.io/BayesFactor/) : for
+    hypothesis testing
+
+-   [`bayestestR`](https://easystats.github.io/bayestestR/): for
+    posterior estimation
+
 | Analysis                        | Function             | Hypothesis testing             | Estimation                     |
 |---------------------------------|----------------------|--------------------------------|--------------------------------|
 | (one/two-sample) t-test         | `bf_ttest`           | <font color="green">Yes</font> | <font color="green">Yes</font> |

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 2.11.0.2
 pkgdown: 1.6.1
 pkgdown_sha: ~
 articles: {}
-last_built: 2020-10-16T17:37Z
+last_built: 2020-10-17T07:32Z
 urls:
   reference: https://indrajeetpatil.github.io/tidyBF//reference
   article: https://indrajeetpatil.github.io/tidyBF//articles

diff --git a/docs/reference/bf_contingency_tab.html b/docs/reference/bf_contingency_tab.html
diff --git a/docs/reference/bf_corr_test.html b/docs/reference/bf_corr_test.html