Pipeline: Pipeline visualisations
In makepipe: Pipeline Tools Inspired by 'GNU Make'
Pipeline R Documentation
Pipeline visualisations
Description
A Pipeline object is automatically constructed as calls to
make_*() are made. It stores the relationships between targets,
dependencies, and sources.
Public fields
segmentsA list of Segment objects
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Method add_source_segment()
Add an edge to edges
Add any nodes in private$edges that are missing from
private$nodes into private$nodes
Reconstruct Pipeline edges from Segment edges. Called
primarily to update outofdateness
Add a pipeline segment corresponding to a make_with_source()
call
Usage
Pipeline$add_source_segment(
source,
targets,
dependencies,
packages,
envir,
force
)
Arguments
sourceThe path to an R script which makes the targets
targetsA character vector of paths to files
dependenciesA character vector of paths to files which the
targets depend on
packagesA character vector of names of packages which targets
depend on
envirThe environment in which to execute the source or recipe.
forceA logical determining whether or not execution of the source
or recipe will be forced (i.e. happen whether or not the targets are
out-of-date)
new_edgeAn data.frame constructed with new_edge()
Returns
The SegmentSource added to the Pipeline
Method add_recipe_segment()
Add a pipeline segment corresponding to a make_with_recipe()
call
Usage
Pipeline$add_recipe_segment(
recipe,
targets,
dependencies,
packages,
envir,
force
)
Arguments
recipeA language object which, when evaluated, makes the targets
targetsA character vector of paths to files
dependenciesA character vector of paths to files which the
targets depend on
packagesA character vector of names of packages which targets
depend on
envirThe environment in which to execute the source or recipe.
forceA logical determining whether or not execution of the source
or recipe will be forced (i.e. happen whether or not the targets are
out-of-date)
Returns
The SegmentRecipe added to the Pipeline
Method build()
Build all targets
Usage
Pipeline$build(quiet = getOption("makepipe.quiet"))
Arguments
quietA logical determining whether or not messages are signaled
Returns
self
Method clean()
Clean all targets
Usage
Pipeline$clean()
Returns
self
Method annotate()
Apply annotations to Pipeline
Usage
Pipeline$annotate(labels = NULL, notes = NULL)
Arguments
labelsA named character vector mapping nodes in the Pipeline onto
labels to display beside them.
notesA named character vector mapping nodes in the Pipeline onto
notes to display on beside the labels (nomnoml) or as tooltips (visNetwork).
Method refresh()
Refresh Pipeline to check outofdateness
Usage
Pipeline$refresh()
Method nomnoml()
Display the pipeline with nomnoml
Usage
Pipeline$nomnoml(
direction = c("down", "right"),
arrow_size = 1,
edge_style = c("hard", "rounded"),
bend_size = 0.3,
font = "Courier",
font_size = 12,
line_width = 3,
padding = 16,
spacing = 40,
leading = 1.25,
stroke = "#33322E",
fill_arrows = FALSE,
gutter = 5,
edge_margin = 0
)
Arguments
directionThe direction the flowchart should go in
arrow_sizeThe arrowhead size
edge_styleThe arrow edge style
bend_sizeThe degree of rounding in the arrows (requires
edge_style=rounded)
fontThe name of a font to use
font_sizeThe font size
line_widthThe line width for arrows and box outlines
paddingThe amount of padding within boxes
spacingThe amount of spacing between boxes,
leadingThe amount of spacing between lines of text
strokeThe color of arrows, text, and box outlines
fill_arrowsWhether arrow heads are full triangles (TRUE) or
angled (FALSE)
gutterThe amount space to leave around the flowchart
edge_marginThe amount of space to leave between boxes and arrows
Returns
self
Method visnetwork()
Display the pipeline with nomnoml
Usage
Pipeline$visnetwork(...)
Arguments
...Arguments (other than nodes and edges) to pass to
visNetwork::visNetwork()
Returns
self
Method text_summary()
Display a text summary of the pipeline
Usage
Pipeline$text_summary()
Returns
self
Method print()
Display
Usage
Pipeline$print(...)
Arguments
...Arguments (other than nodes and edges) to pass to
visNetwork::visNetwork()
Returns
self
Method save_visnetwork()
Save pipeline visNetwork
Usage
Pipeline$save_visnetwork(file, selfcontained = TRUE, background = "white", ...)
Arguments
fileFile to save HTML into
selfcontainedWhether to save the HTML as a single self-contained
file (with external resources base64 encoded) or a file with external
resources placed in an adjacent directory.
backgroundText string giving the html background color of the
widget. Defaults to white.
...Arguments (other than nodes and edges) to pass to
visNetwork::visNetwork()
Returns
self
Method save_nomnoml()
Save pipeline nomnoml
Usage
Pipeline$save_nomnoml(file, width = NULL, height = NULL, ...)
Arguments
fileFile to save the png into
widthImage width
heightImage height
...Arguments to pass to self$nomnoml()
Returns
self
Method save_text_summary()
Save a text summary of the pipeline
Usage
Pipeline$save_text_summary(file)
Arguments
fileFile to save text summary into
Returns
self
Method clone()
The objects of this class are cloneable with this method.
Usage
Pipeline$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
See Also
Other pipeline:
pipeline-accessors,
pipeline-vis
makepipe documentation built on Dec. 7, 2022, 5:16 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Pipeline | R Documentation |
Pipeline visualisations
Description
A Pipeline object is automatically constructed as calls to
make_*() are made. It stores the relationships between targets,
dependencies, and sources.
Public fields
segmentsA list of
Segmentobjects
Methods
Public methods
Method add_source_segment()
Add an edge to edges
Add any nodes in private$edges that are missing from
private$nodes into private$nodes
Reconstruct Pipeline edges from Segment edges. Called primarily to update outofdateness
Add a pipeline segment corresponding to a make_with_source()
call
Usage
Pipeline$add_source_segment( source, targets, dependencies, packages, envir, force )
Arguments
sourceThe path to an R script which makes the
targetstargetsA character vector of paths to files
dependenciesA character vector of paths to files which the
targetsdepend onpackagesA character vector of names of packages which
targetsdepend onenvirThe environment in which to execute the
sourceorrecipe.forceA logical determining whether or not execution of the
sourceorrecipewill be forced (i.e. happen whether or not the targets are out-of-date)new_edgeAn data.frame constructed with
new_edge()
Returns
The SegmentSource added to the Pipeline
Method add_recipe_segment()
Add a pipeline segment corresponding to a make_with_recipe()
call
Usage
Pipeline$add_recipe_segment( recipe, targets, dependencies, packages, envir, force )
Arguments
recipeA language object which, when evaluated, makes the
targetstargetsA character vector of paths to files
dependenciesA character vector of paths to files which the
targetsdepend onpackagesA character vector of names of packages which
targetsdepend onenvirThe environment in which to execute the
sourceorrecipe.forceA logical determining whether or not execution of the
sourceorrecipewill be forced (i.e. happen whether or not the targets are out-of-date)
Returns
The SegmentRecipe added to the Pipeline
Method build()
Build all targets
Usage
Pipeline$build(quiet = getOption("makepipe.quiet"))Arguments
quietA logical determining whether or not messages are signaled
Returns
self
Method clean()
Clean all targets
Usage
Pipeline$clean()
Returns
self
Method annotate()
Apply annotations to Pipeline
Usage
Pipeline$annotate(labels = NULL, notes = NULL)
Arguments
labelsA named character vector mapping nodes in the
Pipelineonto labels to display beside them.notesA named character vector mapping nodes in the
Pipelineonto notes to display on beside the labels (nomnoml) or as tooltips (visNetwork).
Method refresh()
Refresh Pipeline to check outofdateness
Usage
Pipeline$refresh()
Method nomnoml()
Display the pipeline with nomnoml
Usage
Pipeline$nomnoml(
direction = c("down", "right"),
arrow_size = 1,
edge_style = c("hard", "rounded"),
bend_size = 0.3,
font = "Courier",
font_size = 12,
line_width = 3,
padding = 16,
spacing = 40,
leading = 1.25,
stroke = "#33322E",
fill_arrows = FALSE,
gutter = 5,
edge_margin = 0
)Arguments
directionThe direction the flowchart should go in
arrow_sizeThe arrowhead size
edge_styleThe arrow edge style
bend_sizeThe degree of rounding in the arrows (requires
edge_style=rounded)fontThe name of a font to use
font_sizeThe font size
line_widthThe line width for arrows and box outlines
paddingThe amount of padding within boxes
spacingThe amount of spacing between boxes,
leadingThe amount of spacing between lines of text
strokeThe color of arrows, text, and box outlines
fill_arrowsWhether arrow heads are full triangles (
TRUE) or angled (FALSE)gutterThe amount space to leave around the flowchart
edge_marginThe amount of space to leave between boxes and arrows
Returns
self
Method visnetwork()
Display the pipeline with nomnoml
Usage
Pipeline$visnetwork(...)
Arguments
...Arguments (other than
nodesandedges) to pass tovisNetwork::visNetwork()
Returns
self
Method text_summary()
Display a text summary of the pipeline
Usage
Pipeline$text_summary()
Returns
self
Method print()
Display
Usage
Pipeline$print(...)
Arguments
...Arguments (other than
nodesandedges) to pass tovisNetwork::visNetwork()
Returns
self
Method save_visnetwork()
Save pipeline visNetwork
Usage
Pipeline$save_visnetwork(file, selfcontained = TRUE, background = "white", ...)
Arguments
fileFile to save HTML into
selfcontainedWhether to save the HTML as a single self-contained file (with external resources base64 encoded) or a file with external resources placed in an adjacent directory.
backgroundText string giving the html background color of the widget. Defaults to white.
...Arguments (other than
nodesandedges) to pass tovisNetwork::visNetwork()
Returns
self
Method save_nomnoml()
Save pipeline nomnoml
Usage
Pipeline$save_nomnoml(file, width = NULL, height = NULL, ...)
Arguments
fileFile to save the png into
widthImage width
heightImage height
...Arguments to pass to
self$nomnoml()
Returns
self
Method save_text_summary()
Save a text summary of the pipeline
Usage
Pipeline$save_text_summary(file)
Arguments
fileFile to save text summary into
Returns
self
Method clone()
The objects of this class are cloneable with this method.
Usage
Pipeline$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
See Also
Other pipeline:
pipeline-accessors,
pipeline-vis
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.