R/compute_corr.R

In katremadhura/ralph: What the Package Does (One Line, Title Case)

#' Computes a tidy correlation
#'
#' @param data input dataset
#' @param var1 name of variable 1 (unquoted)
#' @param var2 name of variable 2 (unquoted)
#'
#' @return a tibble with Pearson correlation and p-value
#' @export
#'
#' @examples
#' compute_corr(data = faithful,var1 = eruptions, var2 = waiting)
#'
#' @importFrom rlang .data
compute_corr <- function(data, var1, var2){

  # compute correlation ----
  stats::cor.test(
    x = data %>% dplyr::pull({{var1}}),
    y = data %>% dplyr::pull({{var2}})
  ) %>%
    # tidy up results ----
  broom::tidy() %>%
    # retain and rename relevant bits ----
  dplyr::select(
    correlation = .data$estimate,
    pval = .data$p.value
  )

}