seasonder_validateAttributesSeaSondeRAPM {SeaSondeR} | R Documentation |
Validate Attributes for a SeaSondeRAPM Object
Description
This function validates the attributes of a given SeaSondeRAPM object to ensure they meet the required specifications.
Usage
seasonder_validateAttributesSeaSondeRAPM(seasonde_apm_obj)
Arguments
seasonde_apm_obj |
A SeaSondeRAPM object whose attributes are to be validated. |
Details
The function performs validation on the following attributes of the SeaSondeRAPM object:
quality_matrix
BEAR
Type
Creator
SiteName
SiteOrigin
FileName
CreateTimeStamp
ProcessingSteps
AmplitudeFactors
AntennaBearing
StationCode
BearingResolution
Smoothing
CommentLine
FileID
PhaseCorrections
It internally calls specific validation functions for each of these attributes. If any of the attributes are found to be invalid, the function will stop execution and display an error message.
Value
TRUE if all attributes are valid. The function will stop execution and display an error message if any of the attributes are invalid.
See Also
validate_SeaSondeRAPM_quality_matrix
,
validate_SeaSondeRAPM_BEAR
,
validate_SeaSondeRAPM_Type
,
validate_SeaSondeRAPM_Creator
,
validate_SeaSondeRAPM_SiteName
,
validate_SeaSondeRAPM_SiteOrigin
,
validate_SeaSondeRAPM_FileName
,
validate_SeaSondeRAPM_CreateTimeStamp
,
validate_SeaSondeRAPM_ProcessingSteps
,
validate_SeaSondeRAPM_AmplitudeFactors
,
validate_SeaSondeRAPM_AntennaBearing
,
validate_SeaSondeRAPM_StationCode
,
validate_SeaSondeRAPM_BearingResolution
,
validate_SeaSondeRAPM_Smoothing
,
validate_SeaSondeRAPM_CommentLine
,
validate_SeaSondeRAPM_FileID
,
validate_SeaSondeRAPM_PhaseCorrections
Examples
# Create a test SeaSondeRAPM object by reading sample file
apm_file <- system.file("css_data/MeasPattern.txt", package = "SeaSondeR")
obj <- seasonder_readSeaSondeRAPMFile(apm_file)
valid <- seasonder_validateAttributesSeaSondeRAPM(obj)