R/f_my_correlation_test.R

In scROSHI: Robust Supervised Hierarchical Identification of Single Cells

#' Spearman correlation test
#'
#' Calculate spearman correlation p-value or return preset values.
#'
#' @param x A numeric vector of values.
#' @param y A numeric vector of values.
#' @param min_genes A numeric value defining the threshold for the minimum number of genes.
#' @return A numeric value representing the p value of the Spearman correlation test.
#'
#' @export
#'
#' @examples
#' f_my_correlation_test(rnorm(10,1,2),rnorm(10,5,2))

f_my_correlation_test <- function(x, y, min_genes = 5) {
  if (length(x) >= min_genes & length(y) >= min_genes) {
    return(stats::cor.test(x, y, alternative = "greater", method = "spearman", exact=F)$p.value)
  } else {
    return(1)
  }
}