Summary Method for SeaSondeRCS Object — summary.SeaSondeRCS • SeaSondeR

Provides a concise summary of a SeaSondeRCS object by printing the processing steps that have been applied to the data contained in the object.

Usage

# S3 method for class 'SeaSondeRCS'
summary(object, ...)

Arguments

object: 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) and processing step information retrieved by the function seasonder_getSeaSondeRCS_ProcessingSteps.
...: Additional arguments. Currently not used, but supplied for compatibility with generic summary methods.

Value

Invisibly returns the original SeaSondeRCS object.

Details

This method first validates that the input object inherits from the "SeaSondeRCS" class. It then retrieves the processing steps applied to the data using seasonder_getSeaSondeRCS_ProcessingSteps, formats them into a readable string, and outputs the result via the cat function. The function is designed for interactive use, and its output facilitates quick inspection of the object.

Examples

obj <- list(header = list(nSiteCodeName = "Station1",
                            nDateTime = Sys.time(),
                            nDopplerCells = 256,
                            nRangeCells = 100))
class(obj) <- "SeaSondeRCS"
summary(obj)
#> Processing steps:
#>