From 310447d01326098577988164bc2c0a11e8580045 Mon Sep 17 00:00:00 2001
From: Soumya Ray <soumya.ray@gmail.com>
Date: Sat, 6 Apr 2024 12:13:36 +0800
Subject: [PATCH] feat: interactive regression can use OS-specific graphics
 window

---
 DESCRIPTION                   |  2 +-
 R/regression_interactive.R    | 22 +++++++++++++++++-----
 man/interactive_regression.Rd |  6 ++++--
 3 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 9118d65..d31a1b2 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -13,7 +13,7 @@ Imports:
 Depends: R (>= 4.0.0)
 License: MIT
 Encoding: UTF-8
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
diff --git a/R/regression_interactive.R b/R/regression_interactive.R
index 850ee0d..5755200 100644
--- a/R/regression_interactive.R
+++ b/R/regression_interactive.R
@@ -3,7 +3,7 @@
 #' Interactive visualization function that lets you point-and-click to add data points, while it automatically plots and updates a regression line and associated statistics.
 #'   
 #' @param points An optional \code{dataframe} of *x* and *y* points to plot and estimate the regression. If no \code{points} are provided, the user is free to click and create points on the plot area.
-#' 
+#' @param noRStudioGD Do not use the RStudio graphics device even if specified as the default device (set \code{TRUE} in case of issues with RStudio graphics; will open new OS specific graphics window)
 #' @param ... Further arguments passed to the \code{plot_regr()} function that produces the plot.
 #' 
 #' @return A \code{dataframe} containing the points coordinates. Additionally, the following parameters are provided on the plot area:
@@ -16,7 +16,7 @@
 #'  \item{R-squared}{The multiple coefficient of determination.}
 #' 
 #' @usage 
-#' interactive_regression(points, ...)
+#' interactive_regression()
 #' 
 #' Click on the plotting area to add points and see a corresponding regression line (hitting ESC will stop the simulation).
 #'
@@ -32,12 +32,19 @@
 #' # Providing coordinates beforehand
 #' points <- data.frame(x = c(1, 4, 7), y = c(2, 5, 8))
 #' 
-#' # Replotting the coordinates and continuing the interactive regression
+#' # Plotting the new coordinates and starting the interactive regression
 #' interactive_regression(points)
 #'
 #' @export
-interactive_regression <- function(points=data.frame(), ...) {
-  cat("Click on the plot to create data points; hit [esc] to stop")
+interactive_regression <- function(points=data.frame(), noRStudioGD=FALSE, ...) {
+  cat("Click on the plot to create data points; hit [esc] to stop\n")
+  cat("note: if points are not accurately showing, please add noRStudioGD=TRUE\n")
+  
+  if (noRStudioGD) {
+    graphics.off()
+    dev.new(noRStudioGD = noRStudioGD)
+  }
+  
   repeat {
     plot_regr(points, ...)
     
@@ -51,5 +58,10 @@ interactive_regression <- function(points=data.frame(), ...) {
     }
   }
   
+  if (noRStudioGD) {
+    graphics.off()
+    compstatslib::plot_regr(points)
+  }
+  
   return(points)
 }
diff --git a/man/interactive_regression.Rd b/man/interactive_regression.Rd
index 5df944e..0758662 100644
--- a/man/interactive_regression.Rd
+++ b/man/interactive_regression.Rd
@@ -4,13 +4,15 @@
 \alias{interactive_regression}
 \title{compstatslib interactive_regression() function}
 \usage{
-interactive_regression(points, ...)
+interactive_regression()
 
 Click on the plotting area to add points and see a corresponding regression line (hitting ESC will stop the simulation).
 }
 \arguments{
 \item{points}{An optional \code{dataframe} of *x* and *y* points to plot and estimate the regression. If no \code{points} are provided, the user is free to click and create points on the plot area.}
 
+\item{noRStudioGD}{Do not use the RStudio graphics device even if specified as the default device (set \code{TRUE} in case of issues with RStudio graphics; will open new OS specific graphics window)}
+
 \item{...}{Further arguments passed to the \code{plot_regr()} function that produces the plot.}
 }
 \value{
@@ -36,7 +38,7 @@ interactive_regression(pts)
 # Providing coordinates beforehand
 points <- data.frame(x = c(1, 4, 7), y = c(2, 5, 8))
 
-# Replotting the coordinates and continuing the interactive regression
+# Plotting the new coordinates and starting the interactive regression
 interactive_regression(points)
 
 }