R: Read a Sontek ADP File

read.adp.sontek {oce}

R Documentation

Read a Sontek ADP File

Description

Read a Sontek acoustic-Dopplerprofiler file [1].

Usage

read.adp.sontek(file, from = 1, to, by = 1, tz = getOption("oceTz"),
  longitude = NA, latitude = NA, type = c("adp", "pcadp"),
  monitor = FALSE, despike = FALSE, processingLog,
  debug = getOption("oceDebug"), ...)

Arguments

`file`	a connection or a character string giving the name of the file to load. (For `read.adp.sontek.serial`, this is generally a list of files, which will be concatenated.
`from`	indication of the first profile to read. This can be an integer, the sequence number of the first profile to read, or a POSIXt time before which profiles should be skipped, or a character string that converts to a POSIXt time (assuming UTC timezone). See “Examples”, and make careful note of the use of the `tz` argument.
`to`	if supplied, an indication of the last profile to read, in a format as described for `from`. If not supplied, the whole file will be read.
`by`	an indication of the stride length to use while walking through the file. If this is an integer, then `by-1` profiles are skipped between each pair of profiles that is read. If this is a string representing a time interval, in colon-separated format (MM:SS), then this interval is divided by the sampling interval, to get the stride length.
`tz`	character string indicating time zone to be assumed in the data.
`longitude`	optional signed number indicating the longitude in degrees East.
`latitude`	optional signed number indicating the latitude in degrees North.
`type`	A character string indicating the type of instrument.
`monitor`	boolean, set to `TRUE` to provide an indication (with numbers and dots) of every profile read.
`despike`	if `TRUE`, `despike` will be used to clean anomalous spikes in heading, etc.
`processingLog`	if provided, the action item to be stored in the log. (Typically only provided for internal calls; the default that it provides is better for normal calls by a user.)
`debug`	a flag that turns on debugging. Set to 1 to get a moderate amount of debugging information, or to 2 to get more.
`...`	additional arguments, passed to called routines.

Value

An adp object, i.e. one inheriting from adp-class.

Author(s)

Dan Kelley and Clark Richards

References

1. Information about Sontek profilers is available at

http://www.sontek.com.