rt_ts_plot_time_series: plots a time-series dataset
In shane-kercheval/rtools: Package providing R tools and wrappers

rt_ts_plot_time_series

R Documentation

plots a time-series dataset

Description

plots a time-series dataset

Usage

rt_ts_plot_time_series(
  dataset,
  show_values = FALSE,
  show_points = FALSE,
  show_dates = FALSE,
  include_last_point = TRUE,
  fitted_dataset = NULL,
  show_fit_points_values = FALSE,
  forecasted_dataset = NULL,
  show_forecasted_points_values = TRUE,
  y_zoom_min = NA,
  y_zoom_max = NA,
  facet_multi_variables = FALSE,
  line_colors = NULL,
  text_size = 4,
  base_size = 11
)

Arguments

`dataset`	ts dataset
`show_values`	show text value above each point in time
`show_points`	show points
`show_dates`	show dates above each point in time
`include_last_point`	default TRUE; if FALSE, removes the last (most recent) point; if float (0 < include_last_point < 1) then the value represents how far into the time period it is and projects accordingly; e.g. if the last point has a value of '100' and include_last_point is '0.25' (i.e. 25 percent of the way through the current period), then '100' will be adjusted to '400'.
`fitted_dataset`	adds a fit line based on the dataset passed in
`show_fit_points_values`	shows the fitted points and values if fitted_dataset is not null
`forecasted_dataset`	adds forecasted line points and
`show_forecasted_points_values`	shows the fitted points and values if forecasted_dataset is not null
`y_zoom_min`	adjust (i.e. zoom in) to the y-axis; sets the minimum y-value for the adjustment
`y_zoom_max`	adjust (i.e. zoom in) to the y-axis; sets the maximum y-value for the adjustment
`facet_multi_variables`	if TRUE each variable gets it's own section
`line_colors`	if NULL then black for single-var and rt_colors for multi-var
`text_size`	sets the text size
`base_size`	sets the base size