Document performance and benchmarks #13

update doc with example
meantrix · Jan 8, 2025 · 4240c0c · 4240c0c
1 parent 87de5e9
commit 4240c0c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/R/corr_fun.R b/R/corr_fun.R
@@ -103,7 +103,11 @@
 #' Paul van der Laken, ppsr,2021.
 #' URL \url{https://github.com/paulvanderlaken/ppsr}.
 #'
-#'
+#' @examples
+#' \dontrun{
+#' # since both `nx` and `ny` columns are numerical the method type is defined by `cor.nn`
+#' corr_fun(iris, nx = "Sepal.Length", ny = "Sepal.Width", cor.nn = "dcor")
+#' }
 #' @export
 corr_fun <- function(df,
                      nx,

diff --git a/man/corr_fun.Rd b/man/corr_fun.Rd