From b728dda2f235c042cc1069d90ee354ec185fb1e6 Mon Sep 17 00:00:00 2001 From: giovsaraceno Date: Thu, 26 Sep 2024 14:37:34 +0200 Subject: [PATCH] spell_check Add link to introductory vignette in README and in package help documenation --- R/QuadratiK-package.R | 2 ++ README.md | 2 ++ man/QuadratiK-package.Rd | 3 +++ src/QuadratiK.dll | Bin 1166848 -> 1166848 bytes tests/testthat/test-pk.test.R | 2 +- vignettes/wireless_clustering.Rmd | 2 +- vignettes/wireless_clustering.html | 2 +- 7 files changed, 10 insertions(+), 3 deletions(-) diff --git a/R/QuadratiK-package.R b/R/QuadratiK-package.R index 404b8d3..a111a3f 100644 --- 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 index fe39188..27add8e 100644 --- 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 index 87ec766..68d9f72 100644 --- a/man/QuadratiK-package.Rd +++ b/man/QuadratiK-package.Rd @@ -55,6 +55,9 @@ 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 \code{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 diff --git a/src/QuadratiK.dll b/src/QuadratiK.dll index c41e49c001b433a4e05cd85b72699aa26fd005e0..a199ed23bb9c580a50c8b3ebe9356f0528d3ff75 100644 GIT binary patch delta 81 zcmWN|yA42K0EN-`z2B^12^!IviQ*5siedyU6x=I-1k)0_*! i5k|Pe6TS#UC?XMyM5H1UxhO;_s++p)|NjI-{q7&fh9jK- diff --git a/tests/testthat/test-pk.test.R b/tests/testthat/test-pk.test.R index 85e4a75..985e954 100644 --- 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 index d8c3386..19547ad 100644 --- 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 index 928b25d..fc06b8e 100644 --- a/vignettes/wireless_clustering.html +++ b/vignettes/wireless_clustering.html @@ -516,7 +516,7 @@

The Wireless Indoor Localization Data

Note

If the number of cluster k is not provided to the -plot function, one scatter plot is displeyed for each +plot function, one scatter plot is displayed for each possible number of clusters available in the object of class pkbc.