summary-oce-method: Summarize an oce Object

In oce: Analysis of Oceanographic Data

Summarize an oce Object

Description

Provide a textual summary of some pertinent aspects of the object, including selected components of its metadata slot, statistical and dimensional information on the entries in the data slot, and a listing of the contents of its processingLog slot. The details depend on the class of the object, especially for the metadata slot, so it can help to consult the specialized documentation, e.g. summary,ctd-method for CTD objects (i.e. objects inheriting from the ctd class.) It is important to note that this is not a good way to learn the details of the object contents. Instead, for an object named object, say, one might use str(object) to learn about all the contents, or str(object[["metadata"]]) to learn about the metadata, etc.

Usage

## S4 method for signature 'oce'
summary(object, ...)

Arguments

object	The object to be summarized.
...	Extra arguments (ignored)

Examples

o <- new("oce")
summary(o)

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