as.rsk: Coerce Data Into a rsk Object

View source: R/rsk.R

as.rskR Documentation

Coerce Data Into a rsk Object

Description

Create a rsk object.

Usage

as.rsk(
  time,
  columns,
  filename = "",
  instrumentType = "rbr",
  serialNumber = "",
  model = "",
  sampleInterval = NA,
  debug = getOption("oceDebug")
)

Arguments

time

a vector of times for the data.

columns

a list or data frame containing the measurements at the indicated times; see “Details”.

filename

optional name of file containing the data.

instrumentType

type of instrument.

serialNumber

serial number for instrument.

model

instrument model type, e.g. "RBRduo".

sampleInterval

sampling interval. If given as NA, then this is estimated as the median difference in times.

debug

a flag that can be set to TRUE to turn on debugging.

Details

The contents of columns are be copied into the data slot of the returned object directly, so it is critical that the names and units correspond to those expected by other code dealing with rsk objects. If there is a conductivity, it must be called conductivity, and it must be in units of mS/cm. If there is a temperature, it must be called temperature, and it must be an in-situ value recorded in ITS-90 units. And if there is a pressure, it must be absolute pressure (sea pressure plus atmospheric pressure) and it must be named pressure. No checks are made within as.rsk on any of these rules, but if they are broken, you may expect problems with any further processing.

Value

An rsk object.

Author(s)

Dan Kelley

See Also

Other things related to rsk data: [[,rsk-method, [[<-,rsk-method, ctdFindProfilesRBR(), plot,rsk-method, read.rsk(), rsk, rsk-class, rskPatm(), rskToc(), subset,rsk-method, summary,rsk-method


dankelley/oce documentation built on March 18, 2024, 2:02 p.m.