oce (version 1.8-4)

read.xbt.edf2: Read an xbt File in Sippican Format Type 2

Description

The function was written by inspection of a particular file provided by a user in late 2024. The format has been referred to as MK21 export format, and a key difference to the format handled by read.xbt.edf() is that data columns are separated by tab characters, not spaces. The reading of header data is more rudimentary than is the case for read.xbt.edf(), because the sample data file made available to the author did not seem to have much useful information in its header.

Usage

read.xbt.edf2(
  file,
  longitude,
  latitude,
  encoding = "latin1",
  debug = getOption("oceDebug"),
  processingLog
)

Value

An xbt object.

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.

encoding

a character value that indicates the encoding to be used for this data file, if it is textual. The default value for most functions is "latin1", which seems to be suitable for files containing text written in English and French.

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.

Author

Dan Kelley

Examples

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