file_trace: Trace inputs and outputs for a file

In Sorenson-Impact/sorensonimpact: Sorenson Impact Internal R Package

Description

\lifecycle

experimental Produces a connection graphic linking all inputs to a given file, and all outputs from the file. Currently only works on code files. The ability to specify a data file will be added.

Usage

file_trace(
  file,
  code_path = "project",
  trim_data_path = NULL,
  direction = "down",
  levels_up_max = 10,
  levels_down_max = 10,
  width = NULL,
  height = NULL,
  svg = FALSE,
  return_uml = FALSE
)

Arguments

file	The .R or .Rmd file you want to trace. Can be a partial match for code file, extension not required. For data file, full file name is required with extension.
code_path	The top-level path to search for .R and .Rmd files. The search is recursive to cover all child directories. Defaults to "project" which will search the active project directory.
trim_data_path	Optional regex string to remove from the final displayed output for data file nodes. If most of the data files are in a common directory and thus the information is not informative, specifying that directory will clean up the output by shortening the full path to only the relative path.
direction	A string either "down" (the default) or "right" specifying the direction the relationships are drawn.
levels_up_max	\Sexpr[results=rd]{lifecycle::badge("experimental")} How many levels up the hierarchy to search and draw. Defaults to 10, values less than 2 are ignored.
levels_down_max	\Sexpr[results=rd]{lifecycle::badge("experimental")} How many levels down the hierarchy to search and draw. Defaults to 10, values less than 3 are ignored.
width	Passed to nomnoml. Optional width in pixels for the exported 'png'.
height	Passed to nomnoml. Optional height in pixels for the exported 'png'.
svg	Use 'svg' output instead of 'png'? Notice that rendering in 'svg' is not at a par with 'png' and renders incorrectly at times.
return_uml	Set to TRUE if you want the UML code to be returned instead of the diagram. Defaults to FALSE.

Value

A connection graphic of code files and data files leading into the specified file, and resulting from the specified file.

Note

This is a very early alpha release. Please provide feedback and bug reports.

You will want to use the zoom window to view the result, and be aware that you can zoom in on it using the standard mouse actions, as some will be quite large and will appear impossible to read at the default zoom.

Examples

## Not run: 
file_trace("institution_base")

## End(Not run)

Sorenson-Impact/sorensonimpact documentation built on Nov. 6, 2021, 4:25 a.m.