Learn R Programming

oce (version 0.9-18)

as.oce: Coerce Something Into an oce Object

Description

Coerce Something Into an oce Object

Usage

as.oce(x)

Arguments

x
an item containing data. This may be data frame, list, or an oce object.

Value

Details

This function is limited and not intended for common use. In most circumstances, users should employ a function such as as.ctd to construct specialized oce sub-classes.

as.ctd creates an oce object from data contained within its first argument, which may be a list, a data frame, or an object of oce-class. (In the last case, x is simply returned, without modification.)

If x is a list created by read_odf from the (as yet unreleased) ODF package developed by the Bedford Institute of Oceanography, then ODF2oce is called (with no arguments other than the first) to calculate a return value. If the sub-class inference made by ODF2oce is incorrect, users should call that function directly, specifying a value for its coerce argument.

If x has not been created by read_odf, then the names of the items it contains are examined, and used to try to infer the proper return value. There are only a few cases (although more may be added if there is sufficient user demand). The cases are as follows.

  • Ifxcontains items namedtemperature,pressureand eithersalinityorconductivity, then an object of typectd-classwill be returned.
  • Ifxcontains columns namedlongitudeandlatitude, but no other columns, then an object of classcoastline-classis returned.

Examples

Run this code
as.oce(data.frame(salinity=c(30, 30.5), temperature=c(15, 14), pressure=c(1, 5)))
as.oce(list(longitude=1:3,latitude=11:13))

Run the code above in your browser using DataLab