read.adp {oce} | R Documentation |
Read an ADP data file, producing an adp
object, i.e. one inheriting
from adp-class
.
read.adp(file, from, to, by, tz = getOption("oceTz"), longitude = NA, latitude = NA, manufacturer = c("rdi", "nortek", "sontek"), monitor = FALSE, despike = FALSE, processingLog, debug = getOption("oceDebug"), ...)
file |
a connection or a character string giving the name of the file
to load. (For |
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 |
to |
an optional indication of the last profile to read, in a
format as described for |
by |
an optional indication of the stride length to use while walking through
the file. If this is an integer, then |
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. |
manufacturer |
a character string indicating the manufacturer, used by
the general function |
monitor |
boolean, set to |
despike |
if |
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. |
Several file types can be handled. Some of
these functions are wrappers that map to device names, e.g.
read.aquadoppProfiler
does its work by calling
read.adp.nortek
; in this context, it is worth noting that the
“aquadopp” instrument is a one-cell profiler that might just as well have
been documented under the heading read.adv
.
An adp
object, i.e. one inheriting from adp-class
.
The form of this object varies with instrument type. In some cases
navigational data may be included, e.g. read.adp.rdi
can
read NMEA strings (which get stored in an item called nmea
in the data
slot).
Dan Kelley and Clark Richards
Other things related to adp
data: [[,adp-method
,
[[<-,adp-method
, adp-class
,
adpEnsembleAverage
, adp
,
as.adp
, beamName
,
beamToXyzAdp
, beamToXyzAdv
,
beamToXyz
, beamUnspreadAdp
,
binmapAdp
, enuToOtherAdp
,
enuToOther
,
handleFlags,adp-method
,
plot,adp-method
, read.ad2cp
,
read.adp.nortek
,
read.adp.rdi
,
read.adp.sontek.serial
,
read.adp.sontek
,
read.aquadoppHR
,
read.aquadoppProfiler
,
read.aquadopp
, rotateAboutZ
,
setFlags,adp-method
,
subset,adp-method
,
summary,adp-method
, toEnuAdp
,
toEnu
, velocityStatistics
,
xyzToEnuAdp
, xyzToEnu