Two file types are handled: (1) the "sippican"
format, used
for Sippican XBT files, handled with read.xbt.edf()
, and (2)
the "noaa1"
format, handled with read.xbt.noaa1()
. The first of
these is recognized by read.oce()
, but the second must be called
directly with read.xbt.noaa1()
.
Usage
read.xbt(
file,
type = "sippican",
longitude = NA,
latitude = NA,
encoding = "latin1",
debug = getOption("oceDebug"),
processingLog
)
Arguments
- file
a connection or a character string giving the name of the file to load.
- type
character string indicating type of file, with valid choices being
"sippican"
and"noaa1"
.- longitude, latitude
optional signed numbers indicating the longitude in degrees East and latitude in degrees North. These values are used if
type="sippican"
, but ignored iftype="noaa1"
, because those files contain location information.- 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.
Value
An xbt object.
References
Sippican, Inc. "Bathythermograph Data Acquisition System: Installation, Operation and Maintenance Manual (P/N 308195, Rev. A)," 2003. https://pages.uoregon.edu/drt/MGL0910_Science_Report/attachments/MK21_ISA_Manual_Rev_A.pdf.
See also
Other things related to xbt data:
[[,xbt-method
,
[[<-,xbt-method
,
as.xbt()
,
plot,xbt-method
,
read.xbt.noaa1()
,
subset,xbt-method
,
summary,xbt-method
,
xbt
,
xbt-class
,
xbt.edf
Examples
library(oce)
xbt <- read.oce(system.file("extdata", "xbt.edf", package = "oce"))
summary(xbt)
#> xbt summary
#> -----------
#>
#> * File source: "/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/RtmpIXrf27/temp_libpath97356508eee/oce/extdata/xbt.edf"
#> * Serial Number: 0
#> * Longitude: 4.005
#> * Latitude: -4
#> * Time: 2000-10-10 08:49:38
#> * Data Overview
#>
#> Min. Mean Max. Dim. NAs OriginalName
#> depth [m] 5.4 7.0333 8.7 6 0 Depth
#> temperature [°C, ITS-90] 20.9 20.905 20.91 6 0 Temperature
#> soundSpeed [m/s] 1575.3 1575.3 1575.4 6 0 Sound Velocity
#>
#> * Processing Log
#>
#> - 2024-07-26 11:30:30 UTC: `create 'xbt' object`
#> - 2024-07-26 11:30:30 UTC: `read.xbt.edf(file = file, encoding = encoding)`
plot(xbt)