review CRAN issues

Author: DivadNojnarg

.Rbuildignore

@@ -21,3 +21,4 @@
 ^index\.md$
 ^cran-comments\.md$
 ^vignettes/articles$
+^CRAN-SUBMISSION$

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 0.1.0
+Date: 2025-07-03 09:32:36 UTC
+SHA: 3da178dd8286995549966ed1af73341a4f80e748

DESCRIPTION

@@ -3,17 +3,17 @@ Title: Graph Visualisation Engine Widget for R and 'shiny' Apps
 Version: 0.1.0
 Authors@R: 
     c(
-        person("David", "Granjon", , "[email protected]", role = c("aut", "cre")),
-        person("David", "Schoch", , "[email protected]", role = c("aut")),
-        person(family = "cynkra GmbH", role = "fnd"),
-        person(family = "Bristol Myers Squibb", role = "fnd")
+    person("David", "Granjon", , "[email protected]", role = c("aut", "cre")),
+    person("David", "Schoch", , "[email protected]", role = c("aut")),
+    person(family = "cynkra GmbH", role = "fnd"),
+    person(family = "Bristol Myers Squibb", role = "fnd")
     )
-Description: Create stunning network experiences powered by the 'G6' graph visualisation engine 
-    'JavaScript' library <https://g6.antv.antgroup.com/en>. In 'shiny' mode, modify your 
-    graph directly from the server function to dynamically interact with nodes and edges. 
-    Select your favorite layout among 20 choices. 15 behaviors are available such as 
+Description: Create stunning network experiences powered by the 'G6' graph visualisation engine
+    'JavaScript' library <https://g6.antv.antgroup.com/en>. In 'shiny' mode, modify your
+    graph directly from the server function to dynamically interact with nodes and edges.
+    Select your favorite layout among 20 choices. 15 behaviors are available such as
     interactive edge creation, collapse-expand and brush select.
-    17 plugins designed to improve the user experience such as a mini-map, 
+    17 plugins designed to improve the user experience such as a mini-map,
     toolbars and grid lines. Customise the look and feel of your graph with comprehensive
     options for nodes, edges and more.
 License: MIT + file LICENSE
@@ -33,7 +33,8 @@ Suggests:
     roxy.shinylive,
     testthat (>= 3.0.0),
     stringr,
-    htmltools
+    htmltools,
+    bslib
 VignetteBuilder: quarto, knitr
 Depends: 
     R (>= 4.1.0)

R/layouts.R

@@ -882,18 +882,18 @@ dagre_layout <- function(
 #' @export
 #'
 #' @examples
-#' \dontrun{
-#'  g6(lesmis$nodes, lesmis$edges) |>
-#'    g6_layout(force_atlas2_layout(
-#'      kr = 20,
-#'      preventOverlap = TRUE,
-#'      center = c(250, 250))) |>
-#'    g6_options(autoResize = TRUE) |>
-#'    g6_behaviors(
-#'      "zoom-canvas",
-#'      drag_element()
-#'    )
-#'}
+#' if (interactive()) {
+#'   g6(lesmis$nodes, lesmis$edges) |>
+#'     g6_layout(force_atlas2_layout(
+#'       kr = 20,
+#'       preventOverlap = TRUE,
+#'       center = c(250, 250))) |>
+#'     g6_options(autoResize = TRUE) |>
+#'     g6_behaviors(
+#'       "zoom-canvas",
+#'       drag_element()
+#'     )
+#' }
 force_atlas2_layout <- function(
   barnesHut = NULL,
   dissuadeHubs = FALSE,
@@ -991,16 +991,16 @@ force_atlas2_layout <- function(
 #' @return A list containing the configuration for G6 fruchterman layout.
 #' @export
 #' @examples
-#' \dontrun{
-#' g6(lesmis$nodes, lesmis$edges) |>
-#'  g6_layout(fruchterman_layout(
-#'    gravity = 5,
-#'    speed = 5
-#'  )) |>
-#'  g6_behaviors(
-#'    "zoom-canvas",
-#'    drag_element()
-#'  )
+#' if (interactive()) {
+#'   g6(lesmis$nodes, lesmis$edges) |>
+#'    g6_layout(fruchterman_layout(
+#'      gravity = 5,
+#'      speed = 5
+#'    )) |>
+#'    g6_behaviors(
+#'      "zoom-canvas",
+#'      drag_element()
+#'    )
 #' }
 #'
 fruchterman_layout <- function(
@@ -1058,17 +1058,18 @@ fruchterman_layout <- function(
 #' @return A list containing the configuration for G6 radial layout.
 #' @export
 #' @examples
-#' \dontrun{
-#' radial <- jsonlite::fromJSON("https://assets.antv.antgroup.com/g6/radial.json")
-#' g6(radial$nodes, radial$edges) |>
-#'   g6_layout(radial_layout(
-#'     unitRadius = 100,
-#'     linkDistance = 200
-#'   )) |>
-#'   g6_behaviors(
-#'     "zoom-canvas",
-#'     drag_element()
-#'   )
+#' if (interactive()) {
+#'   g6(jsonUrl = "https://assets.antv.antgroup.com/g6/radial.json") |>
+#'     g6_layout(
+#'       radial_layout(
+#'         unitRadius = 100,
+#'         linkDistance = 200
+#'       )
+#'     ) |>
+#'     g6_behaviors(
+#'       "zoom-canvas",
+#'       drag_element()
+#'     )
 #' }
 #'
 radial_layout <- function(
@@ -1242,7 +1243,6 @@ dendrogram_layout <- function(
 #' the outer layout manages the overall arrangement.
 #'
 #' @examples
-#' \dontrun{
 #' # Basic combo combined layout
 #' layout <- combo_combined_layout()
 #'
@@ -1252,7 +1252,6 @@ dendrogram_layout <- function(
 #'   nodeSize = 15,
 #'   spacing = 10
 #' )
-#' }
 #'
 #' @seealso \code{\link{antv_dagre_layout}} for dagre layout configuration
 #'

R/proxy.R

@@ -99,19 +99,39 @@ g6_get <- function(graph, el, type) {
 #' @rdname g6-get
 #' @export
 #' @examples
-#'  \dontrun{
-#'    # Send query to JS
-#'    observeEvent(req(input[["graph-initialized"]]), {
-#'      g6_proxy("graph") |> g6_get_nodes(c("node1", "node2"))
-#'    })
-#'
-#'    # Recover query result inside input[["<GRAPH_ID>-<ELEMENT_ID>-state"]]
-#'    output$res <- renderPrint({
-#'      list(
-#'        node1_state = input[["graph-node1-state"]],
-#'        node2_state = input[["graph-node2-state"]]
-#'      )
-#'    })
+#'  if (interactive()) {
+#'    library(shiny)
+#'    library(bslib)
+#'
+#'     ui <- page_fluid(
+#'       verbatimTextOutput("res"),
+#'       g6Output("graph")
+#'     )
+#'
+#'     server <- function(input, output, session) {
+#'       output$graph <- renderG6({
+#'         g6(
+#'           nodes = data.frame(id = c("node1", "node2"))
+#'         ) |>
+#'           g6_options(animation = FALSE) |>
+#'           g6_layout() |>
+#'           g6_behaviors(click_select())
+#'       })
+#'
+#'       # Send query to JS
+#'       observeEvent(req(input[["graph-initialized"]]), {
+#'         g6_proxy("graph") |> g6_get_nodes(c("node1", "node2"))
+#'       })
+#'
+#'       # Recover query result inside input[["<GRAPH_ID>-<ELEMENT_ID>-state"]]
+#'       output$res <- renderPrint({
+#'         list(
+#'           node1_state = input[["graph-node1-state"]],
+#'           node2_state = input[["graph-node2-state"]]
+#'         )
+#'       })
+#'     }
+#'     shinyApp(ui, server)
 #'  }
 g6_get_nodes <- function(graph, nodes) {
   g6_get(graph, nodes, type = "Node")

R/utils.R

@@ -10,6 +10,8 @@ dropNulls <- function(x) {
 #' @param ... Any valid JS element.
 #'
 #' @export
+#' @return A character vector with class "JS_EVAL" that can be used in htmlwidgets
+#' to mark is as a JavaScript function.
 JS <- function(...) {
   x <- c(...)
   if (is.null(x)) {

cran-comments.md

@@ -4,3 +4,9 @@
 
 * This is a new release.
 * I kept only 1 vignette within doc (Getting started) as it is very large to due to the underlying JavaScript [dependencies](https://github.com/antvis/G6) (the dependency would be typically copied for each vignette which can easily grow to 10MB). I have no way to reduce the size further as I am not maintainer of the G6 JavaScript API. The g6R JavaScript assets have been minimized as much as possible using standard JS minification techniques powered by webpack.
+
+### Resubmission
+
+* Fixed DESCRIPTION spaces.
+* Add missing `@return` to `JS()` documentation.
+* Do not use `dontrun` in roxygen doc. Replaced by `if (interactive())` in some contexts.