flow_view_deps: Show dependency graph of a function

In moodymudskipper/flow: View and Browse Code Using Flow Diagrams

Show dependency graph of a function

Description

Usage

flow_view_deps(
  fun,
  max_depth = Inf,
  trim = NULL,
  promote = NULL,
  demote = NULL,
  hide = NULL,
  show_imports = c("functions", "packages", "none"),
  out = NULL,
  lines = TRUE,
  include_formals = TRUE
)

Arguments

fun	A function, can be of the form fun, pkg::fun, pkg:::fun, if in the form fun, the binding should be located in a package namespace or the global environment. It can also be a named list of functions, such as one you'd create with dplyr::lst(), for instance lst(fun1, pkg::fun2).
max_depth	An integer, the maximum depth to display
trim	A vector or list of function names where the recursion will stop
promote	A vector or list of external functions to show as internal functions
demote	A vector or list of internal functions to show as external functions
hide	A vector or list of internal functions to completely remove from the chart
show_imports	Whether to show imported "functions", only "packages", or "none"
out	a path to save the diagram to. Special values "html", "htm", "png", "pdf", "jpg" and "jpeg" can be used to export the object to a temp file of the relevant format and open it, if a regular path is used the format will be guessed from the extension.
lines	Whether to show the number of lines of code next to the function name
include_formals	Whether to fetch dependencies in the default values of the function's arguments

Details

Exported objects are shown in blue, unexported objects are shown in yellow.

Regular expressions can be used in trim, promote, demote and hide, they will be used on function names in the form pkg::fun or pkg:::fun where pkg can be any package mentioned in these arguments, the namespace of the explored function, or any of the direct dependencies of the package. These arguments must be named, using the name "pattern". See examples below.

Value

flow_view_deps() returns a "flow_diagram" object by default, and the output path invisibly if out is not NULL (called for side effects).

Examples

flow_view_deps(here::i_am)
flow_view_deps(here::i_am, demote = "format_dr_here")
flow_view_deps(here::i_am, trim = "format_dr_here")
flow_view_deps(here::i_am, hide = "format_dr_here")
flow_view_deps(here::i_am, promote = "rprojroot::get_root_desc")
flow_view_deps(here::i_am, promote = c(pattern = ".*::g"))
flow_view_deps(here::i_am, promote = c(pattern = "rprojroot::.*"))
flow_view_deps(here::i_am, hide = c(pattern = "here:::s"))

moodymudskipper/flow documentation built on Oct. 10, 2023, 11:19 p.m.