Base Visualizer Class
Visualizer.RdBase class for all visualizers. Provides a common interface for creating and saving plots across different plotting backends (ggplot2 for 1D/2D, plotly for 3D).
Methods
Method plot()
Base plot method that sets up common plot settings and resolves layer colors. This method should be called by all child classes via `super$plot(...)`.
Usage
Visualizer$plot(
theme = NULL,
plot_title = NULL,
plot_subtitle = NULL,
x_lab = NULL,
y_lab = NULL,
z_lab = NULL,
x_limits = NULL,
y_limits = NULL,
z_limits = NULL,
show_legend = TRUE,
legend_title = NULL,
show_title = TRUE
)Arguments
theme(`list`)
Partial theme override for this render; see vistool_theme().plot_title(`character(1)`)
Main plot title. If NULL, uses the visualizer's default title. Default is NULL.plot_subtitle(`character(1)`)
Plot subtitle. If NULL, no subtitle is shown. Default is NULL.x_lab(`character(1)`)
X-axis label. If NULL, uses the visualizer's default label. Default is NULL.y_lab(`character(1)`)
Y-axis label. If NULL, uses the visualizer's default label. Default is NULL.z_lab(`character(1)`)
Z-axis label (for surface plots). If NULL, uses the visualizer's default label. Default is NULL.x_limits(`numeric(2)`)
X-axis limits as c(min, max). If NULL, uses automatic limits. Default is NULL.y_limits(`numeric(2)`)
Y-axis limits as c(min, max). If NULL, uses automatic limits. Default is NULL.z_limits(`numeric(2)`)
Z-axis limits as c(min, max) (for surface plots). If NULL, uses automatic limits. Default is NULL.show_legend(`logical(1)`)
Whether to show the legend. Default is TRUE.legend_title(`character(1)`)
Title for the legend. If NULL, uses default based on visualizer type. Default is NULL.show_title(`logical(1)`)
Indicator whether to show the title of the plot.
Method resolve_layer_colors()
Resolve automatic color assignments in stored layers. This method should be called by child classes after rendering layers.
Method save()
Save the plot to a file. The format is determined by the file extension.
Arguments
filename(`character(1)`)
The filename to save the plot to. The file extension determines the format.width(`numeric(1)`)
Width of the plot in pixels (for plotly) or inches (for ggplot2).height(`numeric(1)`)
Height of the plot in pixels (for plotly) or inches (for ggplot2).dpi(`numeric(1)`)
Resolution for ggplot2 plots (ignored for plotly plots)....Additional arguments passed to the underlying save function.
Method add_points()
Add points to the plot. This method can be called multiple times to add different sets of points.
Usage
Visualizer$add_points(
points,
color = "auto",
size = NULL,
shape = 19,
alpha = NULL,
annotations = NULL,
annotation_size = NULL,
ordered = FALSE,
arrow_color = NULL,
arrow_size = 0.3
)Arguments
points(`data.frame` or `matrix` or `list`)
The points to add. - For 1D: A `data.frame` or `matrix` with one column for x-values, or a numeric vector of x-values. If y-values are not provided, they will be inferred if possible (e.g., for objective functions). - For 2D/Surface: A `data.frame` or `matrix` with two columns (x1, x2), or a list of 2-element vectors.color(`character(1)`)
Color of the points. Use "auto" for automatic color assignment from palette. Default is "auto".size(`numeric(1)`)
Size of the points. If NULL, uses theme$point_size. Default is NULL.shape(`integer(1)` or `character(1)`)
Shape of the points. For ggplot2: integer codes (e.g., 19 for solid circle). For plotly: shape names. Default is 19/"circle".alpha(`numeric(1)`)
Alpha transparency of the points. If NULL, uses theme$alpha. Default is NULL.annotations(`character`)
Optional text labels for each point. If provided, must be the same length as the number of points.annotation_size(`numeric(1)`)
Size of annotation text. If NULL, defaults to text_size - 2 from plot().ordered(`logical(1)`)
If `TRUE`, draws arrows between consecutive points to indicate order. Default is `FALSE`.arrow_color(`character(1)`)
Color of arrows when ordered = TRUE. If NULL, uses point color.arrow_size(`numeric(1)`)
Length/size of arrows when `ordered = TRUE`. Default is 0.3 units in the coordinate system.