Skip to contents

This function reads a SeaSonde APM file and returns a SeaSondeRAPM object containing the parsed data.

Usage

seasonder_readSeaSondeRAPMFile(
  file_path,
  override_antenna_bearing = NULL,
  override_phase_corrections = NULL,
  override_amplitude_factors = NULL,
  override_SiteOrigin = NULL,
  ...
)

Arguments

file_path

The path to the SeaSonde APM file to read.

override_antenna_bearing

If not NULL, overrides the Antenna Bearing data in the file.

override_phase_corrections

If not NULL, overrides the phase corrections in the file.

override_amplitude_factors

If not NULL, overrides the amplitude factors in the file.

override_SiteOrigin

If not NULL, overrides the SiteOrigin attribute.

...

Additional arguments passed to the object creation function.

Value

A SeaSondeRAPM object containing the parsed data.

Examples

# Read a test SeaSondeRAPM object from sample file
apm_file <- system.file("css_data/MeasPattern.txt", package = "SeaSondeR")
obj <- seasonder_readSeaSondeRAPMFile(apm_file)
#> seasonder_createSeaSondeRAPM:  APM object created successfully.