plotWF {systemPipeR} | R Documentation |
Visualize SPR workflow and status. plotWF
is the general function
that creates the plot.
plotwfOutput
and renderPlotwf
are used in Shiny UI and server
respectively, similar to plotOutput
and renderPlot
.
plotWF( sysargs, width = NULL, height = NULL, elementId = NULL, responsive = TRUE, branch_method = "auto", branch_no = NULL, layout = "compact", no_plot = FALSE, plot_method = "svg", out_format = "plot", out_path = NULL, show_legend = TRUE, mark_main_branch = FALSE, rstudio = FALSE, in_log = FALSE, rmarkdown = "detect", verbose = FALSE, show_warns = FALSE, exit_point = 0 ) plotwfOutput( outputId, width = '100%', height = '400px' ) renderPlotwf( expr, env = parent.frame(), quoted = FALSE )
sysargs |
The workflow structure dataframe |
width |
string, a valid CSS string for width, like "500px", "100%" |
height |
string, a valid CSS string for height, like "500px", "100%" |
elementId |
string, optional ID value for the plot |
responsive |
bool, should the plot be responsive? useful in Rstudio built-in viewer, Rmarkdown, Shiny or embed it into other web pages. |
branch_method |
string, one of "auto", "choose". How to determine the main branch of the workflow. "auto" will be determined by internal alrgothrim: Branches connecting the frist and last step and/or the longest will be favored. "choose" will list all possible branches and you can make a choice. |
branch_no |
numeric, only works if |
layout |
string, one of "compact", "vertical", "horizontal", "execution" |
no_plot |
bool, if you want to assgin the plot to a variable and do not want
to see it interactively, change this to |
plot_method |
string, one of "svg", "png", how to make plot, use svg or png to embed the plot. |
out_format |
string, one of "plot", "html", "dot", "dot_print"
|
out_path |
string, if the |
show_legend |
bool, show plot legend? |
mark_main_branch |
bool, color the main branch on the plot? |
rstudio |
bool, if you are using Rstudio, open the built-in viewer to see the plot? Default is no, open the browser tab to see it plot. The default viewer is too small to see the full plot clearly, so we recommend to use the broswer tab. |
in_log |
bool, is this plot been made in a SPR log file? If |
rmarkdown |
are you rendering this plot in a Rmarkdown document? default value is
"detect", this function will determine based on current R environment, or you
can force it to be |
verbose |
bool, turn on verbose mode will give you more information |
outputId |
string, shiny output ID |
expr |
An expression that generates a plotwf, like |
env |
The environment in which to evaluate |
quoted |
Is |
show_warns |
bool, print the warning messages on the plot?. |
exit_point |
numeric, for advanced debugging only, see details |
compact: try to plot steps as close as possible.
vertical: main branch will be placed vertically and side branches will be placed on the same horizontal level and sub steps of side branches will be placed vertically.
horizontal: main branch is placed horizontally and side branches and sub steps will be placed vertically.
execution: a linear plot to show the workflow execution order of all steps.
return intermediate results at different points and exit the function
0: no early exit
1: after all branches are found, return tree
2: after the new tree has been built, return new nodes
3: after dot translation, return graph string
Rmarkdown will change some of the format and cause conflicts. If the plot can be rendered outside Rmd but cannot within Rmd, try to turn this option on. Some additional javascript processing will be performed to avoid the conflict but may cause unknown issues.
When the plot is rendered in a Shiny app, the rstudio
option must be turned on,
plotWF(sal, rstudio = TRUE, ...)
.
see out_format
and exit_point