recreated documentation

mgimond · Dec 15, 2024 · 222cce8 · 222cce8
1 parent 4729864
commit 222cce8
Show file tree

Hide file tree

Showing 102 changed files with 10,834 additions and 183 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -25,6 +25,7 @@ export(eda_rline)
 export(eda_rtrim)
 export(eda_rtrim_df)
 export(eda_shuffle)
+export(eda_sim)
 export(eda_sl)
 export(eda_sym)
 export(eda_theo)

diff --git a/NEWS.md b/NEWS.md
@@ -6,6 +6,7 @@
 *  Added the `eda_theopan` function that generates multi-panel theoretical QQ plots.
 *  Added the `eda_qqpool` function that generates multi-panel pooled residual plots.
 *  Added the `eda_shuffle` function that permutes values across groups.
+*  Added the `eda_sim` function that simulates distributions.
 *  `eda_sl` now outputs Cleveland's spread-location plot as well as Tukey's spread-versus-level plot.
 *  Added `eda_untie` function that splits ties in a vector by nudging them by a small amount.
 *  Fixed bug in `eda_rline` where incorrect residuals were returned.

diff --git a/README.Rmd b/README.Rmd
@@ -23,8 +23,9 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 <!-- badges: end -->
 
 The `tukeyedar` package houses data exploration tools. Many functions are inspired by work published by
-@eda1977, @understanding_eda1983, @applied_eda1981, and @visdata1993. Note that this package is in beta mode, so use at your own
-discretion. 
+@eda1977, @understanding_eda1983, @applied_eda1981, and @visdata1993. 
+
+> This package was initially developed for an introductory course in Exploratory Data Analysis (EDA). As such, many of its functions have not undergone the rigorous testing and validation typically required for research or production use. Users are advised to exercise caution and verify results independently before applying the package in critical or high-stakes contexts. 
 
 ## Installation
 

diff --git a/README.md b/README.md
@@ -12,8 +12,14 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 
 The `tukeyedar` package houses data exploration tools. Many functions
 are inspired by work published by Tukey (1977), Hoaglin (1983), Velleman
-and Hoaglin (1981), and Cleveland (1993). Note that this package is in
-beta mode, so use at your own discretion.
+and Hoaglin (1981), and Cleveland (1993).
+
+> This package was initially developed for an introductory course in
+> Exploratory Data Analysis (EDA). As such, many of its functions have
+> not undergone the rigorous testing and validation typically required
+> for research or production use. Users are advised to exercise caution
+> and verify results independently before applying the package in
+> critical or high-stakes contexts.
 
 ## Installation
 

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/articles/RLine.html b/docs/articles/RLine.html
diff --git a/docs/articles/RLine_files/figure-html/unnamed-chunk-22-1.png b/docs/articles/RLine_files/figure-html/unnamed-chunk-22-1.png
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/polish.html b/docs/articles/polish.html
diff --git a/docs/articles/qq.html b/docs/articles/qq.html