R/RcppExports.R

In bdevoe/VesselTrackeR: Tools for connecting to vessel tracking APIs and processing vessel track data.

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' Add track data to ping data.
#'
#' For an input dataframe containing tracking data, adds the following
#' columns:
#' * _ping_time_next_pnt_ - POSIX column representing the time at the next
#' point in the track.
#' * _dist_to_next_pnt_ - The distance in meters to next point in the track.
#' * _sec_to_next_pnt_ - the time in seconds between the current point and the
#' next point in the track.
#' * _track_id_ - An integer value identifying all points within the same track
#' * _pnt_in_track_ - An integer value incrementing per point in each track
#' * _calc_speed_ - The calculated speed at the point in meters/second, based
#' on the distance to the next point divided by the time to the next point.
#'
#' The input dataframe should be sorted by device identifier and ping time.
#'
#' @rdname add_track_data
#' @author Bill DeVoe, \email{William.DeVoe@@maine.gov}
#' @param data **Dataframe** - input data.
#' @param id **String** - column name that contains the tracking device ID,
#' used to group tracks.
#' @param timestamp **String** - POSIXct column name that contains the timestamp
#'  of tracking data for each point.
#' @param daysplit **Boolean** - If True, tracks be split at the end of each
#' calendar day.
#' @param timesplit **Optional** **Integer** - Split tracks if more than this
#' many minutes between pings.
#' @param distsplit **Optional** **Integer** - Split tracks if more than this
#' many meters between pings.
#' @return Dataframe of tracking data.
#' @export
add_track_data <- function(data, id, timestamp, latitude, longitude, daysplit, timesplit = -1L, distsplit = -1L) {
    .Call('_VesselTrackeR_add_track_data', PACKAGE = 'VesselTrackeR', data, id, timestamp, latitude, longitude, daysplit, timesplit, distsplit)
}