introducing rstudio addin for dso repro stage

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.5.1
+
+### New Features
+
+-   Introduced the rstudio addin to `dso repro` the current stage
+
 ## v0.5.0
 
 ### New Features

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: dso
 Type: Package
 Title: dso R companion package
-Version: 0.5.0
+Version: 0.5.1
 Author: Daniel Schreyer<[email protected]>,
     Gregor Sturm<[email protected]>,
     Thomas Schwarzl<[email protected]>
@@ -18,7 +18,8 @@ Imports:
     here,
     stringr,
     methods,
-    rlang
+    rlang,
+    rstudioapi (>= 0.11)
 RoxygenNote: 7.3.2
 Suggests:
     testthat (>= 3.0.0)

NAMESPACE

@@ -6,6 +6,7 @@ S3method(print,dsoParams)
 export(compile_config)
 export(create_stage)
 export(dsoParams)
+export(dso_repro_addin)
 export(init)
 export(read_params)
 export(reload)

R/addin.R

@@ -0,0 +1,49 @@
+#' Execute dso repro and display the result
+#'
+#' This function runs the `dso repro` command on the specified `dvc.yaml` file
+#' and displays the resulting report in the RStudio Viewer pane.
+#'
+#' @return None
+#' @export
+#' @examples
+#' \dontrun{
+#' dso_repro_addin()
+#' }
+#' @export
+dso_repro_addin <- function() {
+  tryCatch({
+    if (length(stage_here()) == 0) {
+      stop("stage_here() is not defined. Please read in your config file using read_params().")
+    } else {
+      stage_path <- stage_here()
+    }
+
+    dvc_yaml_path <- file.path(stage_path, "dvc.yaml")
+
+    tryCatch({
+      message(glue::glue("Reproducing the current stage"))
+      result <- system2(DSO_EXEC,
+                        c("repro -s", shQuote(dvc_yaml_path)))
+      if (result != 0) {
+        stop("System command failed with status: {result}")
+      }
+      message("System command executed successfully")
+    }, error = function(e) {
+      glue::glue("An error occurred while executing dso repro")
+    })
+
+    report_files <- list.files(stage_here("report"), pattern = "\\.pdf$|\\.html$", full.names = TRUE)
+
+    if (length(report_files) == 1) {
+      report_file <- report_files[1]
+      message(glue::glue("Report generated: {report_file}"))
+      message(glue::glue("Displaying report file: {report_file}"))
+      # Check the file extension and display in the viewer
+          rstudioapi::viewer(report_file)
+      } else {
+      stop("No report file or multiple report files were identified. Please check the report directory.")
+    }
+  }, error = function(e) {
+    message(glue::glue("An error occurred: {e$message}"))
+  })
+}

R/class-dsoParams.R

@@ -113,10 +113,10 @@ setMethod(
 
 #' @title reload function
 #' @description
-#'
-#' Generic for function reload
+#' Generic function for reloading configurations.
 #'
 #' @param object dsoParams config object
+#' @param ... Additional arguments passed to the method.
 #' @export
 setGeneric("reload", function(object,...) standardGeneric("reload"))
 

inst/rstudio/addins.dcf

@@ -0,0 +1,4 @@
+Name: dso repro stage
+Description: Execute dso repro and display the result in the viewer
+Binding: dso_repro_addin
+Interactive: false