change: changes for CRAN submission

DESCRIPTION

@@ -21,7 +21,7 @@ Authors@R:
     person(given = "VU Analytics",
            role = "cph"
            ))
-Description: Provides a user-friendly R Shiny app for performing various statistical tests on datasets. 
+Description: Provides a user-friendly R 'shiny' app for performing various statistical tests on datasets. 
   It allows users to upload data in numerous formats and perform statistical analyses. 
   The app dynamically adapts its options based on the selected columns and supports both single and multiple column comparisons.
   The app's user interface is designed to streamline the process of selecting datasets, columns, and test options, 

R/global.R

@@ -3,6 +3,7 @@
 #' Helper function to display a data table in a Shiny app.
 #'
 #' @param data The data frame to display.
+#' @return A Shiny output object representing the data table
 #'
 #' @export
 #'
@@ -370,7 +371,7 @@ perform_statistical_test <- function(data, input) {
       )
     },
     error = function(e) {
-      cat(paste0("Error: ", e))
+      stop(paste0("Error: ", e))
       NULL
     }
   )

R/run_vvdoctor.R

@@ -2,14 +2,14 @@
 #'
 #' This function starts the Shiny app, which allows users to upload data and perform
 #' statistical tests on the dataset.
+#' @return No return value, the function runs the Shiny app
+#' @examples
+#' if (interactive()) {
+#'   run_vvdoctor()
+#' }
 #'
 #' @export
 #'
-#' @examples
-#' \dontrun{
-#' library(vvdoctor)
-#' run_statistical_test_app()
-#' }
 run_vvdoctor <- function() {
   shiny::shinyApp(ui = app_ui(), server = app_server)
 }
@@ -21,15 +21,14 @@ run_vvdoctor <- function() {
 #' and perform various statistical tests on the dataset. Users can select the
 #' dependent and independent variables, choose the appropriate statistical test,
 #' and view the results.
+#' @examples
+#' if (interactive()) {
+#'   diagnose()
+#' }
 #'
 #' @return NULL The function does not return a value, but launches the Shiny app.
 #' @export
 #'
-#' @examples
-#' \dontrun{
-#' library(vvdoctor)
-#' diagnose()
-#' }
 diagnose <- function() {
   shiny::shinyApp(ui = app_ui(), server = app_server)
 }

R/server.R

@@ -4,6 +4,8 @@
 #' @param output The output object from the Shiny app.
 #' @param session The session object from the Shiny app.
 #'
+#' @return No return value, called for side effects
+#'
 #' @export
 app_server <- function(input, output, session) {
   shiny::observeEvent(input$launch_modal, {

R/ui.R

@@ -1,5 +1,6 @@
 #' App UI
 #'
+#' @return A Shiny UI object
 #' @export
 #'
 app_ui <- function() {