seasonder_exportCTFRangeInfo: Export CTF Range Information to a File

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Export CTF Range Information to a File

Description

This function writes the formatted CTF range information, generated from a SeaSondeRCS object, to a specified file.

Usage

seasonder_exportCTFRangeInfo(seasonder_cs_object, file, tableStart = "")

Arguments

seasonder_cs_object	A SeaSondeRCS object containing the relevant MUSIC processing data.
file	A character string specifying the output file path where the range information will be written.
tableStart	A character string to prepend to the table output. Defaults to an empty string.

Details

The function internally calls seasonder_exportCTFRangeInfo_string to obtain a formatted string of range information. It then writes this output string to the specified file. Additionally, it returns the extracted range information invisibly, allowing further processing if necessary.

Value

Invisibly returns a data frame containing the range information.

Examples

  # Prepare a SeaSondeRCS object with valid data
  apm_file <- system.file("css_data/MeasPattern.txt", package = "SeaSondeR")
  apm_obj <- seasonder_readSeaSondeRAPMFile(apm_file)
  cs_file <- system.file("css_data/CSS_TORA_24_04_04_0700.cs", package = "SeaSondeR")
  cs_obj <- seasonder_createSeaSondeRCS(
    cs_file,
    seasonder_apm_object = apm_obj
  )
  # Export CTF range information to a temporary text file
  range_info <- seasonder_exportCTFRangeInfo(cs_obj, tempfile(fileext = ".txt"))

SeaSondeR documentation built on June 8, 2025, 10:50 a.m.