seasonder_defaultSpecsFilePath: Get the Default Specifications File Path

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Get the Default Specifications File Path

Description

This function returns the default file path for the specifications YAML file corresponding to the provided type. The type must be one of the names defined in the default paths (i.e., "CS" or "CSSY").

Usage

seasonder_defaultSpecsFilePath(type = "CS")

Arguments

type	A character string specifying the type of specifications file. Default is "CS".

Value

A character string representing the full path to the YAML specifications file.

Examples

  # Retrieve the default CS specifications file path
  cs_specs_path <- seasonder_defaultSpecsFilePath("CS")

  # Retrieve the default CSSY specifications file path
  cssy_specs_path <- seasonder_defaultSpecsFilePath("CSSY")

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