plot-cm-method: Plot a cm Object

plot,cm-methodR Documentation

Plot a cm Object

Description

Creates a multi-panel summary plot of data measured by a current meter.

Usage

## S4 method for signature 'cm'
plot(
  x,
  which = c(1:2),
  type = "l",
  xlim,
  ylim,
  xaxs = "r",
  yaxs = "r",
  drawTimeRange = getOption("oceDrawTimeRange"),
  drawZeroLine = FALSE,
  mgp = getOption("oceMgp"),
  mar = c(mgp[1] + 1.5, mgp[1] + 1.5, 1.5, 1.5),
  small = 2000,
  main = "",
  tformat,
  debug = getOption("oceDebug"),
  ...
)

Arguments

x

a cm object.

which

list of desired plot types. These are graphed in panels running down from the top of the page. See “Details” for the meanings of various values of which.

type

type of plot, as for plot().

xlim, ylim

optional limit to the x and y axes, passed to oce.plot.ts() for time-series plots.

xaxs, yaxs

optional controls over the limits of the x and y axes, passed to oce.plot.ts() for time-series plots. These values default to "r", meaning to use the regular method of extend the plot past its normal limits. It is common to use "i" to make the graph extend to the panel limits.

drawTimeRange

boolean that applies to panels with time as the horizontal axis, indicating whether to draw the time range in the top-left margin of the plot.

drawZeroLine

boolean that indicates whether to draw zero lines on velocities.

mgp

3-element numerical vector to use for par(mgp), and also for par(mar), computed from this. The default is tighter than the R default, in order to use more space for the data and less for the axes.

mar

value to be used with par("mar").

small

an integer indicating the size of data set to be considered "small", to be plotted with points or lines using the standard plot() function. Data sets with more than small points will be plotted with smoothScatter() instead.

main

main title for plot, used just on the top panel, if there are several panels.

tformat

optional argument passed to oce.plot.ts(), for plot types that call that function. (See strptime() for the format used.)

debug

a flag that turns on debugging. Set to 1 to get a moderate amount of debugging information, or to 2 to get more.

...

Optional arguments passed to plotting functions.

Details

The panels are controlled by the which argument, as follows.

  • which=1 or which="u" for a time-series graph of eastward velocity, u, as a function of time.

  • which=2 or which="v" for a time-series graph of northward velocity, u, as a function of time.

  • which=3 or "progressive vector" for progressive-vector plot

  • which=4 or "uv" for a plot of v versus u. (Dots are used for small datasets, and smoothScatter for large ones.)

  • which=5 or "uv+ellipse" as the "uv" case, but with an added indication of the tidal ellipse, calculated from the eigen vectors of the covariance matrix.

  • which=6 or "uv+ellipse+arrow" as the "uv+ellipse" case, but with an added arrow indicating the mean current.

  • which=7 or "pressure" for pressure

  • which=8 or "salinity" for salinity

  • which=9 or "temperature" for temperature

  • which=10 or "TS" for a TS diagram

  • which=11 or "conductivity" for conductivity

  • which=20 or "direction" for the direction of flow

Author(s)

Dan Kelley

See Also

Other functions that plot oce data: download.amsr(), plot,adp-method, plot,adv-method, plot,amsr-method, plot,argo-method, plot,bremen-method, plot,coastline-method, plot,ctd-method, plot,gps-method, plot,ladp-method, plot,landsat-method, plot,lisst-method, plot,lobo-method, plot,met-method, plot,odf-method, plot,rsk-method, plot,satellite-method, plot,sealevel-method, plot,section-method, plot,tidem-method, plot,topo-method, plot,windrose-method, plot,xbt-method, plotProfile(), plotScan(), plotTS(), tidem-class

Other things related to cm data: [[,cm-method, [[<-,cm-method, applyMagneticDeclination,cm-method, as.cm(), cm, cm-class, read.cm(), rotateAboutZ(), subset,cm-method, summary,cm-method

Examples

library(oce)
data(cm)
summary(cm)
plot(cm)


oce documentation built on Sept. 11, 2024, 7:09 p.m.