Updated plots slightly

Author: VisruthSK

R/binomial.R

@@ -222,13 +222,7 @@ binomnorm <- function(k, n, prob, direction) {
 #'
 #' @examples
 binompower <- function(LOS, n, prob1, alternative, prob2 = NULL) {
-  Description <- "iscambinompower(LOS, n, prob1, alternative, prob2) \n This function determines the rejection region \n corresponding to the level of significance and the first probability \n and shows the second distribution shading its corresponding region. \n alternative can be \"less\", \"greater\", or \"two.sided\"."
-
-  if (as.character(LOS) == "?") {
-    stop(Description)
-  }
-
-  thisx <- 0:max(n)
+  thisx <- 0:n
   minx <- max(
     0,
     min(

R/overlayDensities.R

@@ -1,9 +1,9 @@
 #' Template documentation for plotting parameters
 #'
 #' @param x A numeric vector representing the data to be plotted.
-#' @param main What to title the graph.
-#' @param xlab What to label the x-axis.
-#' @param bins Number of bins for the histogram.
+#' @param main Optional title for the plot
+#' @param xlab Optional x-axis label for the plot
+#' @param bins Optional number of bins for the histogram.
 #'
 #' @keywords internal
 #' @name .add_density_common_params
@@ -190,7 +190,6 @@ addtnorm <- function(
   )
 }
 
-
 #' Common processing for plotting histogram and overlaying arbitrary densities
 #'
 #' This internal helper function handles the core logic of creating a histogram

R/plots.R

@@ -1,60 +1,71 @@
+#' Template documentation for plotting parameters
+#'
+#' @param response Vector of numeric values to plot.
+#' @param explanatory Optional second categorical variable to group by.
+#' @param main Optional title for the plot
+#' @param xlab Optional x-axis label for the plot
+#' @param ylab Optional y-axis label for the plot. Only displayed when `explanatory` is provided.
+#'
+#' @keywords internal
+#' @name .plot_funcs_common_params
+NULL
+
 #' A box plot
 #'
 #' `boxplot` plots the given data in a box plot. If a second categorical variable
 #'  is given, the data is grouped by this variable.
 #'
-#' @param x Vector of numeric values to plot.
-#' @param explanatory Optional second categorical variable to group by.
-#' @param main Optional title for the plot
-#' @param xlab Optional x-axis label for the plot
-#' @param ylab Optional y-axis for the plot
+#' @inheritParams .plot_funcs_common_params
 #'
 #' @return A box plot.
 #'
 #' @export
 #'
-#'
 #' @examples
+#' boxplot(
+#'   mtcars$mpg,
+#'   main = "mtcars Cylinders Dotplot",
+#'   xlab = "Number of Cylinders"
+#' )
+#' boxplot(
+#'   mtcars$mpg,
+#'   mtcars$am,
+#'   main = "Automatic Cars Have Better Mileage on Average",
+#'   xlab = "Mileage (miles per gallon)",
+#'   ylab = "Automatic (yes coded as 1)"
+#' )
 boxplot <- function(
-  x,
+  response,
   explanatory = NULL,
   main = "",
   xlab = "",
   ylab = substitute(explanatory)
 ) {
-  # TODO Masks graphics's boxplot?
-  Description <- "iscamboxplot (x, explanatory, names) \n This function displays horizontal boxplot(s) utilizing quartiles instead of hinges to match the summary statistics. \n Optional: A second, categorical variable can also be specified \n and values will be calculated separately for each group. \n  Use the names input to specify the horizontal and vertical axis labels respectively."
-
-  if (as.character(x[1]) == "?") {
-    stop(Description)
-  }
   withr::local_par(mar = c(4, 4, 2, 2))
 
   if (is.null(explanatory)) {
     withr::local_par(mar = c(4, 3, 2, 2))
-    qq <- quantile(x, na.rm = TRUE)
-    bp <- graphics::boxplot(x, plot = FALSE)
+    qq <- quantile(response, na.rm = TRUE)
+    bp <- graphics::boxplot(response, plot = FALSE)
     bp$stats[2, 1] <- qq[2L]
     bp$stats[4, 1] <- qq[4L]
     bxp(bp, horizontal = TRUE, boxfill = "lightgrey")
   } else {
     mylabels <- names(table(explanatory))
     grouparray <- matrix(nrow = length(mylabels), ncol = 5)
-    middle <- tapply(x, explanatory, quantile)
+    middle <- tapply(response, explanatory, quantile)
     proportions <- table(explanatory) / length(explanatory)
-    bp <- graphics::boxplot(x ~ explanatory, plot = FALSE)
+    bp <- graphics::boxplot(response ~ explanatory, plot = FALSE)
     for (i in 1:length(mylabels)) {
       names(middle)[i] <- "group1"
       grouparray[i, ] <- (middle[i]$group1)
       bp$stats[2, i] <- grouparray[i, 2]
       bp$stats[4, i] <- grouparray[i, 4]
     }
-
     bxp(bp, horizontal = TRUE, boxfill = "lightgrey", width = proportions)
-    mtext(side = 2, line = 2, ylab)
   }
-  mtext(side = 1, line = 2, xlab)
-  invisible()
+  title(main = main, xlab = xlab, ylab = ylab)
+  invisible(response)
 }
 
 #' A dot plot
@@ -63,30 +74,32 @@ boxplot <- function(
 #'    given, the data is grouped by this variable. Use `names` & `mytitle` to
 #'    specify the labels and title.
 #'
-#' @param response Vector of numeric values to plot.
-#' @param explanatory Optional second categorical variable to group by.
-#' @param main Optional title for the plot
-#' @param xlab Optional x-axis label for the plot
-#' @param ylab Optional y-axis for the plot
+#' @inheritParams .plot_funcs_common_params
 #'
 #' @return A dot plot.
 #'
 #' @export
 #'
 #' @examples
-#' dotplot(mtcars$cyl, main = "mtcars Cylinders Dotplot", xlab = "Cylinders", ylab = "Counts")
+#' dotplot(
+#'   mtcars$cyl,
+#'   main = "mtcars Cylinders Dotplot",
+#'   xlab = "Number of Cylinders"
+#' )
+#' dotplot(
+#'   mtcars$mpg,
+#'   mtcars$am,
+#'   main = "Automatic Cars Have Better Mileage on Average",
+#'   xlab = "Mileage (miles per gallon)",
+#'   ylab = "Automatic (yes coded as 1)"
+#' )
 dotplot <- function(
   response,
   explanatory = NULL,
   main = "",
   xlab = substitute(response),
   ylab = substitute(explanatory)
 ) {
-  Description <- "iscamdotplot(response, explanatory, names, mytitle) \n This function creates horizontal dotplots. \n If no explanatory variable is specified, just one plot. \n If an explanatory variable is specified, parallel dotplots will be created. \n  Use the names input to specify the horizontal and vertical axis labels respectively and mytitle to specify main. Vertical axis cuts off at 1000."
-
-  if (as.character(response[1]) == "?") {
-    stop(Description)
-  }
   withr::local_par(mar = c(5, 1, 5, 1))
 
   if (is.null(explanatory)) {
@@ -95,9 +108,7 @@ dotplot <- function(
       method = "stack",
       ylim = c(0, 1000),
       pch = 16,
-      main = main,
-      xlab = xlab,
-      ylab = ylab
+      xlab = ""
     )
     abline(h = 0)
   } else {
@@ -111,13 +122,12 @@ dotplot <- function(
       method = "stack",
       ylim = c(ymin, ymax),
       pch = 16,
-      main = main,
-      xlab = xlab,
-      ylab = ylab
+      xlab = ""
     )
     for (i in 1:numCategories) {
       abline(h = i)
     }
   }
+  title(main = main, xlab = xlab, ylab = ylab)
   invisible()
 }