R/getRecursions3D.data.frame.R

In cbracis/recurse: Computes Revisitation Metrics for Trajectory Data

#' @describeIn getRecursions3D Get recursions for a data.frame object consisting of columns x, y, z, datetime, and id
#' @method getRecursions3D data.frame
#' @export
getRecursions3D.data.frame = function(x, radius, threshold = 0, timeunits = c("hours", "secs", "mins", "days"), verbose = TRUE)
{
	# ideas for large data sets:
	# optionally specify locations
	# specify number of clusters and take median of each cluster
	
	
	stopifnot(is.data.frame(x))
	stopifnot(ncol(x) == 5)
	stopifnot(radius > 0)
	timeunits = match.arg(timeunits)
	
	results = getRecursions3DCpp(x[,1], x[,2], x[,3], x[,4], x[,5], x[,1], x[,2], x[,3], 
							   radius, threshold, timeunits, verbose)
	results$timeunits = timeunits
	
	class(results) = "recurse3D"
	
	if (verbose)
	{
		warning("Verbose mode not fully implemented, time calculations not correct")
		class(results) = c("recurse3D", "recurse.verbose")
		
		dataTz = attr(x[,3], "tzone")
		if (!is.null(dataTz))
		{
			# set timezone becasue Rcpp doesn't do it correctly for Datetime
			# https://stackoverflow.com/questions/42919588/setting-datetime-timezone-in-rcpp
			attr(results$revisitStats$entranceTime, "tzone") = dataTz
			attr(results$revisitStats$exitTime, "tzone") = dataTz
		}
	}
	
	return(results)
}