print.SeaSondeRCS {SeaSondeR} | R Documentation |
Print Method for SeaSondeRCS Object
Description
This method provides a formatted printout of the SeaSondeRCS object, displaying the station code, date/time, number of Doppler cells, and number of range cells. It is designed for interactive use, allowing users to quickly inspect the object.
Usage
## S3 method for class 'SeaSondeRCS'
print(x, ...)
Arguments
x |
An object of class "SeaSondeRCS". This object should contain at least a header list with metadata (such as station name, date/time, and cell counts). |
... |
Additional arguments. Currently not used, but supplied for compatibility with generic print methods. |
Details
The function uses the whisker
package to render a template string with the
header information.
Value
Invisibly returns the original SeaSondeRCS object.
Examples
obj <- list(header = list(nSiteCodeName = "Station1",
nDateTime = Sys.time(),
nDopplerCells = 256,
nRangeCells = 100))
class(obj) <- "SeaSondeRCS"
print(obj)
[Package SeaSondeR version 0.2.8 Index]