R/wrapperTraj.R

In traj: Trajectory Analysis

#' @title Wrapper Function to Perform Trajectory Analysis
#' @description Run three steps of trajectory analysis with default parameters.
#' @param Data Data frame containing trajectory data.
#'Each line should contain sequential observations. See details and help file for the \code{\link[traj]{step1measures}} function.
#' @param ID Logical. Set to \code{FALSE} if the first column of \code{Data} corresponds to an \code{ID} variable. Defaults to \code{FALSE}.
#' @return The result is a \code{traj} object. Details can be found in the 'Value' section of \code{\link[traj]{step3clusters}}.
#' @details The function runs the full three step trajectory analysis and returns a \code{traj} object.
#'It will execute \code{\link[traj]{step1measures}}, \code{\link[traj]{step2factors}} and \code{\link[traj]{step3clusters}}
#'sequentially with their default parameters. The result of \code{step3clusters} will be returned. Details regarding 
#'the \code{data} and the \code{time} arguments are found in the 'Details' section of \code{\link[traj]{step1measures}}.
#'
#'@author Marie-Pierre Sylvestre, Dan Vatnik
#'
#'marie-pierre.sylvestre@umontreal.ca
#'
#'@examples 
#'\dontrun{
#' # Setup data
#' data = example.data$data
#' 
#' # Run clustering wrapper function
#' wt = wrapperTraj(data, ID = TRUE)
#'
#' # Display and plot "traj" object
#' wt
#' 
#' summary(wt)
#'
#' plot(wt)
#'}
#'
#'
#' @rdname wrapperTraj
#' @export 
wrapperTraj <- function(Data, ID = FALSE)
{
  s1 = step1measures(Data, ID = ID)
  s2 = step2factors(s1)
  s3 = step3clusters(s2)
  
  return(s3)
}