R/scatterhist.R

In treyhille/MATH4753.0231: Holds MATH4753 functions

#' @title This generates a scatter plot histogram.
#'
#' @param x An object
#' @param y An object
#' @param xlab A label
#' @param ylab A label
#'
#' @return A scatter plot histogram based on two given parameters and their respective labels.
#' @export
#'
#' @examples
#' \dontrun{scatterhist(ddt$LENGTH, ddt$WEIGHT, xlab = "Length", ylab = "Weight")}
#'
scatterhist <- function(x, y, xlab = "", ylab = "")
{
  zones = matrix(c(2, 0, 1, 3), ncol = 2, byrow = TRUE)
  graphics::layout(zones, widths = c(4/5, 1/5), heights = c(1/5, 4/5))
  xhist = graphics::hist(x, plot = FALSE)
  yhist = graphics::hist(y, plot = FALSE)
  top = max(c(xhist$counts, yhist$counts))
  graphics::par(mar = c(3, 3, 1, 1))
  graphics::plot(x,y)
  graphics::par(mar = c(0, 3, 1, 1))
  graphics::barplot(xhist$counts, axes = FALSE, ylim = c(0, top), space = 0)
  graphics::par(mar = c(3, 0, 1, 1))
  graphics::barplot(yhist$counts, axes = FALSE, xlim = c(0, top), space = 0, horiz = TRUE)
  graphics::par(oma=c(3, 3, 0, 0))
  graphics::mtext(xlab, side = 1, line = 1, outer = TRUE, adj = 0,
                  at = .8 * (mean(x) - min(x))/(max(x) - min(x)))
  graphics::mtext(ylab, side = 2, line = 1, outer = TRUE, adj = 0,
                  at = (.8 * (mean(y) - min(y))/(max(y) - min(y))))
}