Creates streamline plots for visualizing 2D flow fields. Shows the path a massless particle would follow in the vector field. Requires the metR package.
Usage
StreamlinePlot(
data,
x,
y,
u,
v,
color_name = NULL,
arrow_size = 0.3,
line_width = 0.6,
L = 5,
res = 2,
split_by = NULL,
split_by_sep = "_",
facet_by = NULL,
facet_scales = "fixed",
facet_nrow = NULL,
facet_ncol = NULL,
facet_byrow = TRUE,
theme = "theme_ggforge_grid",
theme_args = list(),
palette = "Spectral",
palcolor = NULL,
alpha = 0.8,
aspect.ratio = 1,
legend.position = "right",
legend.direction = "vertical",
title = NULL,
subtitle = NULL,
xlab = NULL,
ylab = NULL,
seed = 8525,
combine = TRUE,
nrow = NULL,
ncol = NULL,
byrow = TRUE,
axes = NULL,
axis_titles = NULL,
guides = NULL,
design = NULL,
...
)Arguments
- data
A data frame containing the data to plot
- x, y
Column names for grid coordinates.
- u, v
Column names for velocity components.
- color_name
Legend title for the flow color scale.
- arrow_size
Arrowhead size.
- line_width
Streamline width.
- L
Typical streamline length (metR parameter).
- res
Resolution of starting grid (metR parameter).
- split_by
Column name(s) to split data into multiple plots
- split_by_sep
Separator when concatenating multiple split_by columns
- facet_by
Column name(s) for faceting the plot
- facet_scales
Scales for facets: "fixed", "free", "free_x", "free_y"
- facet_nrow
Number of rows in facet layout
- facet_ncol
Number of columns in facet layout
- facet_byrow
Fill facets by row (TRUE) or column (FALSE)
- theme
Theme name (string) or theme function
- theme_args
List of arguments passed to theme function
- palette
Color palette name
- palcolor
Custom colors for palette
- alpha
Transparency level (0-1)
- aspect.ratio
Aspect ratio of plot panel
- legend.position
Legend position: "none", "left", "right", "bottom", "top"
- legend.direction
Legend direction: "horizontal" or "vertical"
- title
Plot title
- subtitle
Plot subtitle
- xlab
X-axis label
- ylab
Y-axis label
- seed
Random seed for reproducibility
- combine
Whether to combine split plots into one
- nrow
Number of rows when combining plots
- ncol
Number of columns when combining plots
- byrow
Fill combined plots by row
- axes
How to handle axes in combined plots ("keep", "collect", "collect_x", "collect_y")
- axis_titles
How to handle axis titles in combined plots
- guides
How to handle guides in combined plots ("collect", "keep", "auto")
- design
Custom layout design for combined plots
- ...
Additional arguments passed to atomic plotting functions.
See also
Other physics-engineering-plots:
QuiverPlot()
Examples
# \donttest{
grid <- expand.grid(x = seq(-3, 3, 0.3), y = seq(-3, 3, 0.3))
grid$u <- -grid$y
grid$v <- grid$x
StreamlinePlot(grid, x = "x", y = "y", u = "u", v = "v")
# }