adcp_read_txt: Read ADCP txt file

In dempsey-CMAR/adcp: Format and Visualize ADCP data

Read ADCP txt file

Description

Read raw ADCP txt file into R and format. Label each row with the appropriate variable name (i.e., "SensorDepth", "WaterSpeed", or "WaterDirection").

Usage

adcp_read_txt(path, file_name = NULL, rm_dups = TRUE)

Arguments

path	Path to the txt file (including ".txt" extension) or to the folder where the txt file is saved.
file_name	Required if path does not include the file name. Include the ".txt" file extension. Default is file_name = NULL.
rm_dups	Logical argument indicating whether to remove duplicate rows. Default is TRUE. (Note: the Num column is removed before checking for duplicate rows.)

Details

The timestamp_ns column is in the timezone of the deployment date (e.g., "AST" if deployed in November to March and "DST" if deployed in March to November). The timestamp_ns does NOT account for changes in daylight savings time. Here, the timestamp_ns is assigned a timezone of "UTC" to avoid NA values during the beginning of daylight savings time (e.g., 2019-03-10 02:30:00 is NOT a valid time for the "America/Halifax" timezone). This timestamp_ns can be converted to true UTC using adcp_correct_timestamp().

A warning will be printed if duplicate timestamp_ns are detected.

Value

Returns a data frame of the data with a single header row and each row labelled as "SensorDepth", "WaterSpeed", or "WaterDirection".

dempsey-CMAR/adcp documentation built on April 17, 2025, 4:30 a.m.