R/xCorrelation.R

In cwendorf/EASIalt: easiOrigin

# easiOrigin
## Correlations

### Descriptives

.descCorrelation <- function(x, ...) {
  UseMethod(".descCorrelation")
}

.descCorrelation.default <- function(frame, ...) {
  data <- data.frame(frame)
  results <- cor(data)
  results
}

descCorrelation <- function(..., main = NULL, digits = 3) {
  results <- .descCorrelation(...)
  if (is.null(main)) {
    main <- "Correlation Matrix for the Variables"
  }
  .formatList(list(results), main = main, digits = digits)
}

### Confidence Interval Functions

.ciCorrelation <- function(x, ...) {
  UseMethod(".ciCorrelation")
}

.ciCorrelation.default <- function(frame, conf.level = .95, ...) {
  data <- data.frame(frame)
  test <- cor.test(data[, 1], data[, 2])
  results <- data.frame(test[4], test[2], test$conf.int[1], test$conf.int[2])
  colnames(results) <- c("Est", "df", "LL", "UL")
  rownames(results) <- "Correlation"
  round(results, 3)
}

ciCorrelation <- function(..., conf.level = .95, main = NULL, digits = 3) {
  results <- .ciCorrelation(..., conf.level = conf.level)
  if (is.null(main)) {
    main <- "Confidence Interval for the Correlation"
  }
  .formatList(list(results), main = main, digits = digits)
}

### Null Hypothesis Significance Test Functions

.nhstCorrelation <- function(x, ...) {
  UseMethod(".nhstCorrelation")
}

.nhstCorrelation.default <- function(frame, conf.level = .95, ...) {
  data <- data.frame(frame)
  test <- cor.test(data[, 1], data[, 2])
  results <- data.frame(test[4], test[2], test[1], test[3])
  colnames(results) <- c("Est", "df", "t", "p")
  rownames(results) <- "Correlation"
  round(results, 3)
}

nhstCorrelation <- function(..., mu = 0, main = NULL, digits = 3) {
  results <- .nhstCorrelation(..., mu = mu)
  if (is.null(main)) {
    main <- "Hypothesis Test for the Correlation"
  }
  .formatList(list(results), main = main, digits = digits)
}

### Confidence Interval Plot Functions

graphCorrelation <- function(x, ...) {
  UseMethod("graphCorrelation")
}

graphCorrelation.default <- function(frame, main = NULL, ylab = "Correlation", xlab = "", mu = NULL, rope = NULL, conf.level = .95, values = TRUE, ylim = NULL, add = FALSE, digits = 3, ...) {
  results <- .ciCorrelation(frame, conf.level = conf.level)[, c("Est", "LL", "UL")]
  if (is.null(main)) {
    main <- "Confidence Interval for the Correlation"
  }
  .cipMain(results, main = main, ylab = ylab, xlab = xlab, mu = mu, rope = rope, values = values, ylim = ylim, digits = digits, connect = TRUE, add = add, pch = 16)
}