Plot time series trends

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: "year"

y

a string of the column name of data used to plot on the y-axis

Default: "estimate"

geom

type of geom to use for plotting found in ggplot2 (e.g. "point", "line", etc.).

Default: "line"

Options: "point" and "area"

xlab

a string of the x-axis label

Default: "Year"

ylab

a string of the y-axis label. If NULL, it will be set to the name of `y`.

Default: NULL

group

a string of a single column that groups the data. Currently can only have one level of grouping.

Default: NULL Options: Including, but not limited to: "year", "area", "fleet", "sex", "none", NULL

facet

a string or vector of strings of a column that facets the data (e.g. "year", "area", etc.)

Default: NULL

...

inherited arguments from internal functions from ggplot2::geom_xx

Value

Create a time series plot for a stock assessment report.

Details

The user can 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"
)
} # }