partykit: party-plot – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

partykit

party-plot

Visualization of Trees

Description

plot method for party objects with extended facilities for plugging in panel functions.

Usage

## S3 method for class 'party'
plot(x, main = NULL,
    terminal_panel = node_terminal, tp_args = list(),
    inner_panel = node_inner, ip_args = list(),
    edge_panel = edge_simple, ep_args = list(),
    drop_terminal = FALSE, tnex = 1,
    newpage = TRUE, pop = TRUE, gp = gpar(),
    margins = NULL, ...)
## S3 method for class 'constparty'
plot(x, main = NULL,
    terminal_panel = NULL, tp_args = list(),
    inner_panel = node_inner, ip_args = list(),
    edge_panel = edge_simple, ep_args = list(),
    type = c("extended", "simple"), drop_terminal = NULL, 
    tnex = NULL, newpage = TRUE, pop = TRUE, gp = gpar(), 
    ...)
## S3 method for class 'simpleparty'
plot(x, digits = getOption("digits") - 4, tp_args = NULL, ...)

Arguments

`x`	an object of class `party` or `constparty`.
`main`	an optional title for the plot.
`type`	a character specifying the complexity of the plot: `extended` tries to visualize the distribution of the response variable in each terminal node whereas `simple` only gives some summary information.
`terminal_panel`	an optional panel function of the form `function(node)` plotting the terminal nodes. Alternatively, a panel generating function of class `"grapcon_generator"` that is called with arguments `x` and `tp_args` to set up a panel function. By default, an appropriate panel function is chosen depending on the scale of the dependent variable.
`tp_args`	a list of arguments passed to `terminal_panel` if this is a `"grapcon_generator"` object.
`inner_panel`	an optional panel function of the form `function(node)` plotting the inner nodes. Alternatively, a panel generating function of class `"grapcon_generator"` that is called with arguments `x` and `ip_args` to set up a panel function.
`ip_args`	a list of arguments passed to `inner_panel` if this is a `"grapcon_generator"` object.
`edge_panel`	an optional panel function of the form `function(split, ordered = FALSE, left = TRUE)` plotting the edges. Alternatively, a panel generating function of class `"grapcon_generator"` that is called with arguments `x` and `ip_args` to set up a panel function.
`ep_args`	a list of arguments passed to `edge_panel` if this is a `"grapcon_generator"` object.
`drop_terminal`	a logical indicating whether all terminal nodes should be plotted at the bottom.
`tnex`	a numeric value giving the terminal node extension in relation to the inner nodes.
`newpage`	a logical indicating whether `grid.newpage()` should be called.
`pop`	a logical whether the viewport tree should be popped before return.
`gp`	graphical parameters.
`margins`	numeric vector of margin sizes.
`digits`	number of digits to be printed.
`...`	additional arguments passed to callies.

Details

This plot method for party objects provides an extensible framework for the visualization of binary regression trees. The user is allowed to specify panel functions for plotting terminal and inner nodes as well as the corresponding edges. Panel functions for plotting inner nodes, edges and terminal nodes are available for the most important cases and can serve as the basis for user-supplied extensions, see node_inner.

More details on the ideas and concepts of panel-generating functions and "grapcon_generator" objects in general can be found in Meyer, Zeileis and Hornik (2005).

References

Meyer D, Zeileis A, Hornik K (2006). The Strucplot Framework: Visualizing Multi-Way Contingency Tables with vcd. Journal of Statistical Software, 17(3), 1–48. https://www.jstatsoft.org/v17/i03/