Learn R Programming

VTrack (version 1.21)

NonResidenceExtractId: Extract the Non-residence Events, the Corresponding Distance Moved and the Rate of Movement

Description

This function creates a nonresidences data frame from a residences event data frame and a optional distance matrix (sDistanceMatrix). This function is not mandatory as it is carried out automatically if the user provides a distance matrix in the sDistanceMatrix field when running the RunResidenceExtraction function.

Usage

NonResidenceExtractId(sResidenceEventFile, sDistanceMatrix = NULL)

Arguments

sResidenceEventFile

a residence event table

sDistanceMatrix

an optional two dimentional array (matrix) containing the pairwise distances between a series of receivers

Value

STARTTIME

a POSIXct vector object containing the date and time a transmitter left a receiver/station after a residence event

ENDTIME

a POSIXct vector object containing the date and time a transmitter arrived at a receiver/station and a new residence event was logged

NONRESIDENCEEVENT

a numeric vector indexing each nonresidence event

TRANSMITTERID

a numeric or character vector indexing the transmitter from which nonresidence events were determined

RECEIVERID1

a numeric or character vector indexing the receiver which the transmitter initially moved from. If STATIONNAME is specified in the function, STATIONNAME1 is returned

RECEIVERID2

a numeric or character vector indexing the receiver which the transmitter moved to. If STATIONNAME is specified in the function, STATIONNAME2 is returned

DURATION

a numeric vector containing the total time in seconds taken for the transmitter to move between two receivers or stations

DISTANCE

a numeric vector containing the minimum distance travelled in meters between two receivers/stations according to the distance matrix. If a distance matrix was not attached (=NULL), distance is returned as 0

ROM

a numeric vector containing the rate of movement (ROM) in m/s. This is calculated from the distance travelled (i.e. DISTANCE) divided by the time taken to move between the receivers (i.e. DURATION)

See Also

RunResidenceExtraction