R: Read a Sippican '.edf' format xbt file

read.xbt.edf {oce} | R Documentation

## Read a Sippican '.edf' format xbt file

### Description

The function was written by inspection of a particular file, and might be wrong for other files; see “Details” for a note on character translation.

### Usage

    read.xbt.edf(
      file,
      longitude = NA,
      latitude = NA,
      debug = getOption("oceDebug"),
      processingLog
    )

### Arguments

`file` | a connection or a character string giving the name of the file to load.
`longitude` | optional signed number indicating the longitude in degrees East.
`latitude` | optional signed number indicating the latitude in degrees North.
`debug` | a flag that turns on debugging. The value indicates the depth within the call stack to which debugging applies.
`processingLog` | if provided, the action item to be stored in the log. This parameter is typically only provided for internal calls; the default that it provides is better for normal calls by a user.

### Details

The header is converted to ASCII format prior to storage in the `metadata` slot, so that e.g. a degree sign in the original file will become a `?` character in the `header`. This is to prevent problems with submission of `oce` to the CRAN system, which produces NOTEs about UTF-8 strings in data (on some build machines, evidently depending on the locale on those machines). This character substitution is at odds with the `oce` philosophy of leaving data intact, so it will be reverted, if CRAN policy changes or if the developers can find a way to otherwise silence the NOTE.

### Value

An xbt object.

### Author(s)

Dan Kelley

### Examples

    library(oce)
    xbt <- read.oce(system.file("extdata", "xbt.edf", package="oce"))
    summary(xbt)
    plot(xbt)

[Package oce version 1.7-2 Index]