R: Summarize an oce Object

summary,oce-method {oce} | R Documentation

## 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 `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)

[Package oce version 1.0-1 Index]