plotTimeSeries: Plot Time Series

Description Usage Arguments

View source: R/utils-plot.R

Description

Function that takes a gsplot object and the necessary time series data and formats the time series properly for plotting and then plots it.

Usage

1
2
3
plotTimeSeries(plot_object, ts, name, timezone, configFunction,
  configFunctionAdditionalParams, excludeZeroNegativeFlag = FALSE,
  isDV = FALSE)

Arguments

plot_object

The gsplot object to plot onto

ts

The Time Series to plot

name

The variable name to use for the time series (used for style and config matching)

timezone

The timezone of the time series (used for calculating gaps)

configFunction

The function to use for fetching the style and config data for this TS

configFunctionAdditionalParams

additional params to pas into configFunction, config function will be called with (subsetOfSeries, name, and configFunctionAdditionalParams added at end)

excludeZeroNegativeFlag

Whether or not to remove zero and negative values from the ts

isDV

Whether or not the plot is a daily value plot (default: FALSE)


USGS-R/repgen documentation built on April 14, 2021, 2:47 p.m.