added aspect ratio argument

mgimond · Jul 23, 2024 · e5b408b · e5b408b
1 parent 4637335
commit e5b408b
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 3 deletions.
diff --git a/R/eda_lm.R b/R/eda_lm.R
@@ -49,6 +49,10 @@
 #'   function. A robust loess is used by default.
 #' @param rlm.d A list of arguments passed to the \code{MASS::rlm}
 #'   function.
+#' @param asp Boolean determining if the plot aspect ratio should equal the
+#'   ratio of the x and y standard deviations. A value of \code{FALSE} defaults
+#'   to the base plot's default aspect ratio. A value of \code{TRUE} uses the
+#'   aspect ratio \code{sd(x)/sd(y)}.
 #' @param xlab X label for output plot.
 #' @param ylab Y label for output plot.
 #' @param ... Not used.
@@ -128,7 +132,7 @@
 
 eda_lm <- function(dat, x, y, xlab = NULL, ylab = NULL, px = 1, py = 1,
                    tukey = FALSE, show.par = TRUE, reg = TRUE, poly = 1,
-                   robust = FALSE,  w=NULL, sd = TRUE, mean.l = TRUE,
+                   robust = FALSE,  w=NULL, sd = TRUE, mean.l = TRUE,asp = TRUE,
                    grey = 0.6, pch = 21, p.col = "grey50", p.fill = "grey80",
                    size = 0.8, alpha = 0.8, q = FALSE, q.val = c(0.16,0.84),
                    q.type = 5, loe = FALSE, lm.col = rgb(1, 0.5, 0.5, 0.8),
@@ -211,7 +215,9 @@ eda_lm <- function(dat, x, y, xlab = NULL, ylab = NULL, px = 1, py = 1,
   mean.x <- mean(x, na.rm=T)
   mean.y <- mean(y, na.rm=T)
 
-  plot( x=x, y=y , asp=sd.x/sd.y, ylab=NA, las=1, yaxt='n', xaxt='n', xlab=NA,
+  asp_val <- ifelse(asp == TRUE, sd.x/sd.y, NA) # See if x and y SDs need to match
+
+  plot( x=x, y=y , asp=asp_val, ylab=NA, las=1, yaxt='n', xaxt='n', xlab=NA,
         col.lab=plotcol, pch = pch, col = p.col, bg = p.fill, cex = size)
   box(col=plotcol)
   axis(1,col=plotcol, col.axis=plotcol, labels=TRUE, padj = -0.5)

diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png
diff --git a/docs/reference/eda_lm-1.png b/docs/reference/eda_lm-1.png
diff --git a/docs/reference/eda_lm-2.png b/docs/reference/eda_lm-2.png
diff --git a/docs/reference/eda_lm-3.png b/docs/reference/eda_lm-3.png
diff --git a/docs/reference/eda_lm-4.png b/docs/reference/eda_lm-4.png
diff --git a/docs/reference/eda_lm-5.png b/docs/reference/eda_lm-5.png
diff --git a/docs/reference/eda_lm-6.png b/docs/reference/eda_lm-6.png
diff --git a/docs/reference/eda_lm-7.png b/docs/reference/eda_lm-7.png
diff --git a/docs/reference/eda_lm-8.png b/docs/reference/eda_lm-8.png
diff --git a/docs/reference/eda_lm.html b/docs/reference/eda_lm.html
diff --git a/man/eda_lm.Rd b/man/eda_lm.Rd