plot.rsk {oce} | R Documentation

## Plot rsk data

### Description

Rsk data may be in many forms, and it is not easy to devise a general plotting strategy for all of them. The present function is quite crude, on the assumption that users will understand their own datasets, and that they can devise plots that are best-suited to their applications. Sometimes, the sensible scheme is to coerce the object into another form, e.g. using `plot(as.ctd(rsk))` if the object contains CTD-like data. Other times, users should extract data from the `rsk` object and construct plots themselves. The idea is to use the present function mainly to get an overview, and for that reason, the default plot type (set by `which`) is a set of time-series plots, because the one thing that is definitely known about `rsk` objects is that they contain a `time` vector in their `data` slot.

### Usage

    ## S4 method for signature 'rsk'
    plot(x,
         which="timeseries", title="", adorn=NULL,
         tlim, plim, Tlim,
         xlab, ylab,
         tformat,
         drawTimeRange=getOption("oceDrawTimeRange"),
         abbreviateTimeRange=getOption("oceAbbreviateTimeRange"),
         useSmoothScatter=FALSE,
         mgp=getOption("oceMgp"),
         mar=c(mgp[1]+1.5,mgp[1]+1.5,1.5,1.5),
         main="",
         debug=getOption("oceDebug"),
         ...)

### Arguments

`x` | `rsk` object, typically result of `read.rsk`.
`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`.
`title` | character string to be used in the text-summary panel (`which`=2)
`adorn` | list of expressions to be executed for the panels in turn, e.g. to adorn the plots. If the number matches the number of panels, then the strings are applied to the appropriate panels, as they are drawn from top-left to bottom-right. If only a single expression is provided, it is used for all panels. (See “Examples”.)
`tlim` | optional limits for time axis. If not provided, the value will be inferred from the data.
`plim` | optional limits for pressure axis. If not provided, the value will be inferred from the data. (It is helpful to specify this, if the auto-scaled value will be inappropriate, e.g. if more lines are to be added later.)
`Tlim` | optional limits for temperature axis. If not provided, the value will be inferred from the data. (It is helpful to specify this, if the auto-scaled value will be inappropriate, e.g. if more lines are to be added later.)
`xlab` | optional label for x axis.
`ylab` | optional label for y axis.
`tformat` | optional argument passed to `oce.plot.ts`, for plot types that call that function. (See `strptime` for the format used.)
`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.
`abbreviateTimeRange` | boolean that applies to panels with time as the horizontal axis, indicating whether to abbreviate the second time in the time range (e.g. skipping the year, month, day, etc. if it's the same as the start time).
`useSmoothScatter` | a boolean to cause `smoothScatter` to be used for profile plots, instead of `plot`.
`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")`.
`main` | main title for plot, used just on the top panel, if there are several panels.
`debug` | a flag that turns on debugging, if it exceeds 0.
`...` | optional arguments passed to plotting functions.

### Details

Several plots are available.

- `which=0` or `"timeseries"` for time-series plots of each variable; this over-rides any other specification

- `which=1` or `"temperature"` for a time-series plot of temperature

- `which=2` or `"text"` for textual information about the dataset

- `which=3` or `"pressure"` for a time-series plot of pressure

- `which=4` or `"profile"` for a temperature profile

### Author(s)

Dan Kelley

### See Also

The documentation for `rsk-class` explains the structure of `rsk` objects, and also outlines the other functions dealing with them.

### Examples

    library(oce)
    data(rsk)
    plot(rsk, which=c(1,3))

[Package oce version 0.9-18 Index]