sdr: Calculate SDR for an Object

View source: R/cleaning.R

sdrR Documentation

Calculate SDR for an Object

Description

Calculates SDR for an object of certain class

Usage

sdr(x, time_unit = "secs", append_na = TRUE, ...)

## S3 method for class 'track_xyt'
sdr(x, time_unit = "secs", append_na = TRUE, ...)

Arguments

x

⁠[track_xyt]⁠ Object to calculate SDR from. Currently implemented for track_xyt.

time_unit

⁠[character]⁠ Character string giving time unit. Should be "secs", "mins", or "hours".

append_na

⁠[logical]⁠ Should NA be appended to the end of the vector? Ensures length(result) == nrow(x) if appending as a column of x.

...

Further arguments, none implemented.

Details

time_unit defaults to seconds because calculate_sdr() returns SDR in m^2/s. We assume the user is also working in a projected CRS with units in meters, thus we expect SDR in m^2/s to be most relevant.

Author(s)

Brian J. Smith and Johannes Signer

See Also

calculate_sdr(), get_displacement()


amt documentation built on June 25, 2024, 1:14 a.m.