read_odf_header: Read ODF header information

In paleolimbot/oceandf: Read 'ODF' (Ocean Data File) Files

Description

Read ODF header information

Usage

read_odf_header(
  file,
  header = odf_parse_header(file, file_encoding = file_encoding),
  default_col_types = odf_header_cols_default(),
  file_encoding = "latin1"
)

read_odf_parameter_header(
  file,
  col_types = NULL,
  header = odf_parse_header(file, file_encoding = file_encoding),
  file_encoding = "latin1"
)

read_odf_header_tbl(
  file,
  which,
  col_types = NULL,
  header = odf_parse_header(file, file_encoding = file_encoding),
  default_col_types = odf_header_cols_default(),
  file_encoding = "latin1"
)

odf_col_date()

odf_col_datetime()

odf_header_cols_default(...)

odf_parse_header(
  file,
  header_lines = read_odf_header_lines(file, file_encoding = file_encoding),
  file_encoding = "latin1"
)

read_odf_header_lines(file, n_header = 1000, file_encoding = "latin1")

Arguments

file	A file, URL, or connection. Files ending in .gz, .bz2, .xz, or .zip will be automatically uncompressed; URLs will be automatically downloaded. See readr::read_lines() for a full description of how this parameter is interpreted.
header	A previously read value obtained from odf_parse_header().
default_col_types	A possibly more enlightened values than the default odf_header_cols_default().
file_encoding	The encoding used to encode the file. The default (latin1) is used to prevent an error involving invalid characters that are common in ODF files.
col_types	A readr::cols() spec or NULL to guess using odf_guess_col_types()
which	The header name (e.g., "PARAMETER_HEADER"). Most ODF files have an ODF_HEADER, a CRUISE_HEADER, EVENT_HEADER, INSTRUMENT_HEADER, HISTORY_HEADER, PARAMETER_HEADER, and RECORD_HEADER.
...	Overrides for the default column types.
header_lines	A previously read value obtained from read_odf_header_lines().
n_header	The starting guess for number of header lines.

Examples

odf_file <- odf_example("CTD_98911_10P_11_DN.ODF")
read_odf_header(odf_file)
read_odf_header_tbl(odf_file, "CRUISE_HEADER")

paleolimbot/oceandf documentation built on March 9, 2021, 9:43 a.m.