Account for CRAN feedback

moodymudskipper · Jun 6, 2023 · d0ef69f · d0ef69f
1 parent e86a0e0
commit d0ef69f
Show file tree

Hide file tree

Showing 85 changed files with 63 additions and 15 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -14,3 +14,4 @@
 ^\.github$
 ^CRAN-SUBMISSION$
 ^LICENSE\.md$
+^ignored$
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 doc
 inst/doc
 Meta
+ignored
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -1,3 +1,3 @@
 Version: 0.2.0
-Date: 2023-06-04 23:33:51 UTC
-SHA: 59aeabbecd4af017d2833e1bbeb2215e70002681
+Date: 2023-06-05 06:55:57 UTC
+SHA: e86a0e0d487cd7e3ad4b40f88435e1756b0b6bee
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -8,7 +8,7 @@ Authors@R:
            email = "[email protected]")
 Description: Visualize as flow diagrams the logic of functions, expressions or 
   scripts in a static way or when running a call, visualize the dependencies between
-  functions or between modules in a shiny app, and more..
+  functions or between modules in a shiny app, and more.
 License: MIT + file LICENSE
 URL: https://github.com/moodymudskipper/flow, https://moodymudskipper.github.io/flow/
 BugReports: https://github.com/moodymudskipper/flow/issues

diff --git a/R/05_flow_debug.R b/R/05_flow_debug.R
@@ -59,7 +59,8 @@ flow_undebug <- function(f){
 #' @param ... ...
 #' @keywords internal
 #' @export
+#' @return Fails with deprecation error
 flow_debugonce <- function(...) {
-  stop("`flow_debugonce()` is deprecated, use `flow_debug()`")
+  stop("`flow_debugonce()` is defunct, use `flow_debug()`")
 }
 
diff --git a/R/09_flow_view_deps.R b/R/09_flow_view_deps.R
@@ -266,11 +266,11 @@ flow_view_deps_df <- function(target_fun_name, target_fun, trim, promote, demote
 }
 
 deps <- function(pkg) {
-  ip <- installed.packages()
-  setdiff(trimws(union(
-    strsplit(gsub("\\(.*?\\)", "", ip[pkg, "Imports"]), "\\s?,\\s?")[[1]],
-    strsplit(gsub("\\(.*?\\)", "", ip[pkg, "Depends"]), "\\s?,\\s?")[[1]]
-  )), c("R", NA))
+  desc <- read.dcf(system.file("DESCRIPTION", package = pkg))
+  desc <- desc[,intersect(c("Imports", "Depends"), colnames(desc))]
+  setdiff(trimws(unique(unlist(
+    strsplit(gsub("\\(.*?\\)", "", desc), "\\s?,\\s?")
+  ))), c("R", NA))
 }
 
 get_ns_obj_df <- function(ns_nm, lines) {

diff --git a/R/11_flow_view_shiny.R b/R/11_flow_view_shiny.R
@@ -16,6 +16,7 @@
 #' @param pattern A regular expression used to detect ui and server functions
 #' @inheritParams flow_view_deps
 #' @export
+#' @return A flow diagram object.
 #' @examples
 #' if (requireNamespace("esquisse", quietly = TRUE)) {
 #'   flow_view_shiny(esquisse::esquisser, show_imports = "none")

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,3 +1,29 @@
 ## Comments
 
 The package was archive due to the pkgdown html thing last year. This is fixed, core functionalities are the same, some feature were added.
+
+# Answering comments from Benjamin Altmann 2023-06-06
+
+> A CRAN package should not be larger than 5 MB. Please reduce the size.
+
+Size was reduced, tar.gz is 3.6 Mb big
+
+> Please omit one full stop at the end of your DESCRIPTION:
+
+done
+
+> Missing Rd-tags:
+>      flow_debugonce.Rd: \value
+>      flow_view_shiny.Rd: \value
+
+Added \value section for both
+
+> Used ::: in documentation:
+>      man/flow_view_deps.Rd:
+>         flow_view_deps(here::i_am, hide = c(pattern = "here:::s"))
+
+Example was changed to use `::` rather than `:::`
+
+> You are using installed.packages() in your code.
+
+We now gather dependencies from DESCRIPTION files rather than installed.packages()
diff --git a/docs/articles/customize_1.png b/docs/articles/customize_1.png
diff --git a/docs/articles/customize_10.png b/docs/articles/customize_10.png
diff --git a/docs/articles/customize_2.png b/docs/articles/customize_2.png
diff --git a/docs/articles/customize_3.png b/docs/articles/customize_3.png
diff --git a/docs/articles/customize_4.png b/docs/articles/customize_4.png
diff --git a/docs/articles/customize_5.png b/docs/articles/customize_5.png
diff --git a/docs/articles/customize_6.png b/docs/articles/customize_6.png
diff --git a/docs/articles/customize_7.png b/docs/articles/customize_7.png
diff --git a/docs/articles/customize_8.png b/docs/articles/customize_8.png
diff --git a/docs/articles/customize_9.png b/docs/articles/customize_9.png
diff --git a/docs/articles/experimental-functions.html b/docs/articles/experimental-functions.html
diff --git a/docs/articles/flow_compare_runs.png b/docs/articles/flow_compare_runs.png
diff --git a/docs/articles/flow_debugonce.png b/docs/articles/flow_debugonce.png
diff --git a/docs/articles/flow_run_1.png b/docs/articles/flow_run_1.png
diff --git a/docs/articles/flow_run_2.png b/docs/articles/flow_run_2.png
diff --git a/docs/articles/flow_run_3.png b/docs/articles/flow_run_3.png
diff --git a/docs/articles/flow_view_1.png b/docs/articles/flow_view_1.png
diff --git a/docs/articles/flow_view_2.png b/docs/articles/flow_view_2.png
diff --git a/docs/articles/flow_view_3.png b/docs/articles/flow_view_3.png
diff --git a/docs/articles/flow_view_4.png b/docs/articles/flow_view_4.png
diff --git a/docs/articles/flow_view_deps_1.png b/docs/articles/flow_view_deps_1.png
diff --git a/docs/articles/flow_view_deps_2.png b/docs/articles/flow_view_deps_2.png
diff --git a/docs/articles/flow_view_deps_3.png b/docs/articles/flow_view_deps_3.png
diff --git a/docs/articles/flow_view_deps_4.png b/docs/articles/flow_view_deps_4.png
diff --git a/docs/articles/flow_view_deps_5.png b/docs/articles/flow_view_deps_5.png
diff --git a/docs/articles/flow_view_deps_6.png b/docs/articles/flow_view_deps_6.png
diff --git a/docs/articles/flow_view_deps_7.png b/docs/articles/flow_view_deps_7.png
diff --git a/docs/articles/flow_view_shiny.png b/docs/articles/flow_view_shiny.png
diff --git a/docs/articles/flow_view_uses.png b/docs/articles/flow_view_uses.png
diff --git a/docs/articles/flow_view_vars_1.png b/docs/articles/flow_view_vars_1.png
diff --git a/docs/articles/flow_view_vars_2.png b/docs/articles/flow_view_vars_2.png
diff --git a/docs/articles/nested_1.png b/docs/articles/nested_1.png
diff --git a/docs/articles/nested_2.png b/docs/articles/nested_2.png
diff --git a/docs/articles/nested_3.png b/docs/articles/nested_3.png
diff --git a/docs/articles/plantuml.png b/docs/articles/plantuml.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -10,5 +10,5 @@ articles:
   nested-functions: nested-functions.html
   reports: reports.html
   simple-usage: simple-usage.html
-last_built: 2023-06-04T23:30Z
+last_built: 2023-06-06T11:37Z
 
diff --git a/docs/reference/flow-package.html b/docs/reference/flow-package.html
diff --git a/docs/reference/flow_debugonce.html b/docs/reference/flow_debugonce.html
diff --git a/docs/reference/flow_view_shiny.html b/docs/reference/flow_view_shiny.html
diff --git a/man/flow-package.Rd b/man/flow-package.Rd
diff --git a/man/flow_debugonce.Rd b/man/flow_debugonce.Rd
diff --git a/man/flow_view_shiny.Rd b/man/flow_view_shiny.Rd
diff --git a/vignettes/customize_1.png b/vignettes/customize_1.png
diff --git a/vignettes/customize_10.png b/vignettes/customize_10.png
diff --git a/vignettes/customize_2.png b/vignettes/customize_2.png
diff --git a/vignettes/customize_3.png b/vignettes/customize_3.png
diff --git a/vignettes/customize_4.png b/vignettes/customize_4.png
diff --git a/vignettes/customize_5.png b/vignettes/customize_5.png
diff --git a/vignettes/customize_6.png b/vignettes/customize_6.png
diff --git a/vignettes/customize_7.png b/vignettes/customize_7.png
diff --git a/vignettes/customize_8.png b/vignettes/customize_8.png
diff --git a/vignettes/customize_9.png b/vignettes/customize_9.png
diff --git a/vignettes/flow_compare_runs.png b/vignettes/flow_compare_runs.png
diff --git a/vignettes/flow_debugonce.png b/vignettes/flow_debugonce.png
diff --git a/vignettes/flow_run_1.png b/vignettes/flow_run_1.png
diff --git a/vignettes/flow_run_2.png b/vignettes/flow_run_2.png
diff --git a/vignettes/flow_run_3.png b/vignettes/flow_run_3.png
diff --git a/vignettes/flow_view_1.png b/vignettes/flow_view_1.png
diff --git a/vignettes/flow_view_2.png b/vignettes/flow_view_2.png
diff --git a/vignettes/flow_view_3.png b/vignettes/flow_view_3.png
diff --git a/vignettes/flow_view_4.png b/vignettes/flow_view_4.png
diff --git a/vignettes/flow_view_deps_1.png b/vignettes/flow_view_deps_1.png
diff --git a/vignettes/flow_view_deps_2.png b/vignettes/flow_view_deps_2.png
diff --git a/vignettes/flow_view_deps_3.png b/vignettes/flow_view_deps_3.png
diff --git a/vignettes/flow_view_deps_4.png b/vignettes/flow_view_deps_4.png
diff --git a/vignettes/flow_view_deps_5.png b/vignettes/flow_view_deps_5.png
diff --git a/vignettes/flow_view_deps_6.png b/vignettes/flow_view_deps_6.png
diff --git a/vignettes/flow_view_deps_7.png b/vignettes/flow_view_deps_7.png
diff --git a/vignettes/flow_view_shiny.png b/vignettes/flow_view_shiny.png
diff --git a/vignettes/flow_view_uses.png b/vignettes/flow_view_uses.png
diff --git a/vignettes/flow_view_vars_1.png b/vignettes/flow_view_vars_1.png
diff --git a/vignettes/flow_view_vars_2.png b/vignettes/flow_view_vars_2.png
diff --git a/vignettes/nested_1.png b/vignettes/nested_1.png
diff --git a/vignettes/nested_2.png b/vignettes/nested_2.png
diff --git a/vignettes/nested_3.png b/vignettes/nested_3.png
diff --git a/vignettes/plantuml.png b/vignettes/plantuml.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,4 @@ @@
     doc
     inst/doc
     Meta
+    ignored