Plot time series trends

plot_timeseries(
  dat,
  x = "year",
  y = "estimate",
  geom = "line",
  xlab = "Year",
  ylab = NULL,
  group = NULL,
  facet = NULL,
  ...
)

Arguments

dat: filtered data frame from standard output file(s) preformatted for the target label from filter_data
x: a string of the column name of data used to plot on the x-axis (default is "year")
y: a string of the column name of data used to plot on the y-axis (default is "estimate")
geom: type of geom to use for plotting found in ggplot2 (e.g. "point", "line", etc.). Default is "line". Other options are "point" and "area".
xlab: a string of the x-axis label (default is "Year")
ylab: a string of the y-axis label. If NULL, it will be set to the name of `y`.
group: a string of a single column that groups the data (e.g. "fleet", "sex", "area", etc.). Currently can only have one level of grouping.
facet: a string or vector of strings of a column that facets the data (e.g. "year", "area", etc.)
...: inherited arguments from internal functions from ggplot2::geom_xx

Value

Create a time series plot for a stock assessment report. The user has options to create a line, point, or area plot where the x-axis is year and Y can vary for any time series quantity. Currently, grouping is restricted to one group where faceting can be any number of facets.

Examples

if (FALSE) { # \dontrun{
plot_timeseries(dat,
               x = "year",
               y = "estimate",
               geom = "line",
               xlab = "Year",
               ylab = "Biomass",
               group = "fleet",
               facet = "area")
} # }