R/longR.R

In funfield-lab/fancyr: Fancy Statistics for Correlational (r) Analyses

#' Stretch (usually a Correlation) Matrix into an Edgelist Format
#' @description
#' Utility function to translate a correlation matrix to a
#' edgelist format where the correlations are in one column.
#' @param corMat Matrix you want to convert (doesn't need to be a correlation matrix)
#' @usage
#' longR(corMat)
#' @return a dataframe with \code{c("varX","varY","rXY")} layout
#'
#' @export

longR <- function(corMat) {
  temp <- data.frame(rownames(corMat),as.data.frame(corMat))
  rsLong <- tidyr::pivot_longer(temp, cols = 2:ncol(temp), names_to = "var", values_to = "r", values_drop_na = TRUE)
  colnames(rsLong) <- c("varX","varY","rXY")
  return(rsLong)
}