diff --git a/NEWS.md b/NEWS.md index d1478b7..78a959e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -11,7 +11,7 @@ * `flow_view_deps()` accepts a list of functions as input, to display a diagram that starts from several functions. * `flow_view_deps()`'s `trim`, `promote`, `demote`, `trim` arguments support - regular rexpressions. + regular expressions. * `flow_view_doc()` and `flow_view_doc()` were simplified to output only html since the md output was rarely used and brittle. * `flow_debugonce()` is deprecated, use `flow_debug()` and `flow_undebug()` diff --git a/R/11_flow_view_shiny.R b/R/11_flow_view_shiny.R index 0d5c9fe..cc92781 100644 --- a/R/11_flow_view_shiny.R +++ b/R/11_flow_view_shiny.R @@ -4,7 +4,7 @@ #' This function displays a shiny app's module structure, assuming it is built #' on top of module functions named a certain way (adjustable through the `pattern` argument) and #' calling each other. If you call for instance `flow_view_shiny()` on a function that runs the app and -#' uses both the maon server and ui functions, you'll display the full graph of server and ui modules. +#' uses both the main server and ui functions, you'll display the full graph of server and ui modules. #' #' It is wrapper around `flow_view_deps()` which demotes every object that is not #' a server function, a ui function or a function calling either. What is or isn't considered as a diff --git a/docs/articles/experimental-functions.html b/docs/articles/experimental-functions.html index 7667cf3..06b636b 100644 --- a/docs/articles/experimental-functions.html +++ b/docs/articles/experimental-functions.html @@ -26,7 +26,7 @@ - +
- +

Experimental functions

- - + + Source: vignettes/experimental-functions.Rmd
- - + +

Version 0.1.0 features experimental functions to display different kinds of flow diagrams.

These are not stable but already useful and since developing flow @@ -217,7 +217,7 @@

#’ This function displays a shiny app’s module structure, . If you call for instance flow_view_shiny() on a function that runs -the app and #’ uses both the maon server and ui functions, you’ll +the app and #’ uses both the main server and ui functions, you’ll display the full graph of server and ui modules.

flow_view_shiny() is a wrapper around flow_view_deps() to show the structure of a shiny app. It @@ -225,7 +225,7 @@

(adjustable through the pattern argument).

It works nicely on apps built with {golem} or follow the same kind of structure (good practice basically), such as those that you’d build -following the recommendations in Hadley Wickham’s “Mestering Shiny”.

+following the recommendations in Hadley Wickham’s “Mastering Shiny”.

Apps that use source() are not well supported but it might come as we found it’s quite common (though probably not good practice).

@@ -312,10 +312,10 @@

- - + + diff --git a/docs/reference/flow_view_shiny.html b/docs/reference/flow_view_shiny.html index 34b5a71..8ba177f 100644 --- a/docs/reference/flow_view_shiny.html +++ b/docs/reference/flow_view_shiny.html @@ -3,11 +3,11 @@ This function displays a shiny app's module structure, assuming it is built on top of module functions named a certain way (adjustable through the pattern argument) and calling each other. If you call for instance flow_view_shiny() on a function that runs the app and -uses both the maon server and ui functions, you'll display the full graph of server and ui modules."> - +
- +
@@ -88,7 +88,7 @@

Visualize a shiny app's dependency graph

This function displays a shiny app's module structure, assuming it is built on top of module functions named a certain way (adjustable through the pattern argument) and calling each other. If you call for instance flow_view_shiny() on a function that runs the app and -uses both the maon server and ui functions, you'll display the full graph of server and ui modules.

+uses both the main server and ui functions, you'll display the full graph of server and ui modules.

@@ -153,7 +153,7 @@

Arguments

Value

- +

A flow diagram object.

@@ -190,10 +190,10 @@

Examples

- - + + diff --git a/man/flow_view_shiny.Rd b/man/flow_view_shiny.Rd index ec65e73..b604bec 100644 --- a/man/flow_view_shiny.Rd +++ b/man/flow_view_shiny.Rd @@ -49,7 +49,7 @@ A flow diagram object. This function displays a shiny app's module structure, assuming it is built on top of module functions named a certain way (adjustable through the \code{pattern} argument) and calling each other. If you call for instance \code{flow_view_shiny()} on a function that runs the app and -uses both the maon server and ui functions, you'll display the full graph of server and ui modules. +uses both the main server and ui functions, you'll display the full graph of server and ui modules. } \details{ It is wrapper around \code{flow_view_deps()} which demotes every object that is not diff --git a/vignettes/experimental-functions.Rmd b/vignettes/experimental-functions.Rmd index 77ab7b3..f3e8418 100644 --- a/vignettes/experimental-functions.Rmd +++ b/vignettes/experimental-functions.Rmd @@ -121,14 +121,14 @@ Use the `out` argument to export these diagrams. ## `flow_view_shiny()` #' This function displays a shiny app's module structure, . If you call for instance `flow_view_shiny()` on a function that runs the app and -#' uses both the maon server and ui functions, you'll display the full graph of server and ui modules. +#' uses both the main server and ui functions, you'll display the full graph of server and ui modules. `flow_view_shiny()` is a wrapper around `flow_view_deps()` to show the structure of a shiny app. It assumes the app is built on top of module functions named a certain way (adjustable through the `pattern` argument). It works nicely on apps built with {golem} or follow the same kind of structure (good practice basically), such as those that you'd build following the -recommendations in Hadley Wickham's "Mestering Shiny". +recommendations in Hadley Wickham's "Mastering Shiny". Apps that use `source()` are not well supported but it might come as we found it's quite common (though probably not good practice).