Skip to content

Commit

Permalink
Document performance and benchmarks #13
Browse files Browse the repository at this point in the history
update corrp documentation
  • Loading branch information
PHS-Meantrix committed Jan 8, 2025
1 parent 2c4101d commit 87de5e9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion R/corrp.R
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
#' p.value param. If the statistical tests do not obtain a significance greater/less
#' than p.value the value of variable `isig` will be `FALSE`.\cr
#' - There is no statistical significance test for the pps algorithm. By default `isig` is TRUE.\cr
#' - If any errors occur during operations the association measure(`infer.value`) will be `NA`.
#' - If any errors occur during operations the association measure(`infer.value`) will be `NA`.\cr
#' - The result `data` and `index` will have \eqn{N^2} rows, where N is the number of variables of the input data.
#'
#' @param df \[\code{data.frame(1)}]\cr input data frame.
#' @param parallel \[\code{logical(1)}]\cr If its TRUE run the operations in parallel backend.
Expand Down
3 changes: 2 additions & 1 deletion man/corrp.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 87de5e9

Please sign in to comment.