zoc: Zero-offset correct tidy trace data frame

In EmmaLiTsai/recoverKBTDR: Recovering Records From Kooyman-Billups Time Depth Recorders (KBTDRs)

Zero-offset correct tidy trace data frame

Description

Some KBTDR (and modern) records present drift and/or level shifts in surface values. This function is modeled after zero-offset correction methods in the "diveMove" package, which can be explained in (Luque & Fried, 2011).

Usage

zoc(trace, k_h = 500, depth_bounds = c(-1, 1))

Arguments

trace	tidy trace data frame, contains the x and y values of the trace
k_h	numeric value, size of the larger window used for the second filter. This default is set to 500, but should be smaller for records with extreme drift.
depth_bounds	two concatenated numbers restricted search window for where y = 0 should likely be. For the records, this should be in cm. Default set c(-1, 1).

Value

trace data frame after it has been zero-offset corrected

Examples

## Not run: 
zoc(trace, k_h = 500, depth_bounds = c(-1, 1))

## End(Not run)

EmmaLiTsai/recoverKBTDR documentation built on Aug. 29, 2024, 10:38 a.m.