spell_check

Add link to introductory vignette in README and in package help documenation
ropensci · Sep 26, 2024 · b728dda · b728dda
1 parent 14c8428
commit b728dda
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 3 deletions.
diff --git a/R/QuadratiK-package.R b/R/QuadratiK-package.R
@@ -49,6 +49,8 @@
 #'  representing the cluster results as well as enhancing the interpretability 
 #'  and usability of the analysis.
 #'   
+#' For an introduction to `QuadratiK` see the vignette 
+#' \href{../doc/Introduction.html}{Introduction to the QuadratiK Package}.
 #' 
 #' @details The work has been supported by Kaleida Health Foundation and the 
 #' National Science Foundation.

diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@
 
 -   **Additional Features**: Alongside these functionalities, the software includes additional graphical functions, aiding users in validating and representing the cluster results as well as enhancing the interpretability and usability of the analysis.
 
+For an introduction to `QuadratiK` see the vignette [Introduction to the QuadratiK Package](https://giovsaraceno.github.io/QuadratiK-package/articles/Introduction.html).
+
 ## Installation
 
 You can install the version published on CRAN of `QuadratiK`

diff --git a/man/QuadratiK-package.Rd b/man/QuadratiK-package.Rd
diff --git a/src/QuadratiK.dll b/src/QuadratiK.dll
diff --git a/tests/testthat/test-pk.test.R b/tests/testthat/test-pk.test.R
@@ -87,7 +87,7 @@ test_that("Functionality with valid inputs", {
    expect_true(is.numeric(unif_test@Vn))
    expect_false(unif_test@H0_Un)
 
-   # Test does not reject uniformity
+   # Test reject uniformity
    set.seed(123)
    x_sp <- rpkb(n = size, mu = c(1,0,0), rho = 0.9)$x
    unif_test <- pk.test(x_sp,rho=0.9)

diff --git a/vignettes/wireless_clustering.Rmd b/vignettes/wireless_clustering.Rmd
@@ -83,7 +83,7 @@ summary_clust
 
 ## Note
 
-If the number of cluster *k* is not provided to the `plot` function, one scatter plot is displeyed for each possible number of clusters available in the object of class `pkbc`.
+If the number of cluster *k* is not provided to the `plot` function, one scatter plot is displayed for each possible number of clusters available in the object of class `pkbc`.
 
 ## References
 

diff --git a/vignettes/wireless_clustering.html b/vignettes/wireless_clustering.html
@@ -516,7 +516,7 @@ <h3>The Wireless Indoor Localization Data</h3>
 <div id="note" class="section level2">
 <h2>Note</h2>
 <p>If the number of cluster <em>k</em> is not provided to the
-<code>plot</code> function, one scatter plot is displeyed for each
+<code>plot</code> function, one scatter plot is displayed for each
 possible number of clusters available in the object of class
 <code>pkbc</code>.</p>
 </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -83,7 +83,7 @@ summary_clust @@
     ## Note
-    If the number of cluster *k* is not provided to the `plot` function, one scatter plot is displeyed for each possible number of clusters available in the object of class `pkbc`.
+    If the number of cluster *k* is not provided to the `plot` function, one scatter plot is displayed for each possible number of clusters available in the object of class `pkbc`.
     ## References
@@ Expand Down @@