seriesPlot.seaken: Series Plot

View source: R/seriesPlot.seaken.R

seriesPlot.seakenR Documentation

Series Plot

Description

Produces a plot of time-series data by season that shows seasonal and overall trends: method for "seaken" object.

Usage

## S3 method for class 'seaken'
seriesPlot(x, SeasonLine = list(name = "", what = "vertical",
  color = "black"), SeasonPoint = list(name = "", what = "points", symbol =
  "circle", filled = TRUE, size = 0.09, color = "black"), yaxis.log = FALSE,
  yaxis.range = c(NA, NA), ylabels = 7, xlabels = x$seasonames,
  xtitle = "", ytitle = deparse(substitute(x)), caption = "",
  margin = c(NA, NA, NA, NA), SeasonTrend = list(name = "", what = "lines",
  color = "brown"), TrendLine = list(name = "", what = "lines", color =
  "blue"), ...)

Arguments

x

data that can be treated as a regularly-spaced time series.

SeasonLine

control parameters of the lines in the plot. See Details.

SeasonPoint

control parameters of the points in the plot. See Details.

yaxis.log

log-transform the y axis?

yaxis.range

set the range of the y axis.

ylabels

set the y-axis labels. See linearPretty for details.

xlabels

set the x-axis labels, may be a single numeric value indicating the number of season in x. See namePretty for details.

xtitle

the x-axis title.

ytitle

the y-axis title.

caption

the figure caption.

margin

the parameters of the margin of the plot area.

SeasonTrend

control parameters of the trend line for each season. See Details.

TrendLine

control parameters of the overall trend line compute by seaken. See Details.

...

any additional arguments required for specific methods.

Details

The argument what for SeasonLine must be either "lines" or "vertical." See monthplot for more information.
The argument what for either SeasonPoint, SeasonTrend, or trendLine may be set to "none" to suppress drawing of that feature.

Value

Information about the graph.

See Also

monthplot, seasonPlot, seaken


USGS-R/smwrStats documentation built on Oct. 11, 2022, 6:15 a.m.