man/generateRandomPaths.Rd
ece1f4ee
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/TrajectoryGeometry.R
 \name{generateRandomPaths}
 \alias{generateRandomPaths}
 \title{Produce random paths modeled on a given path}
 \usage{
 generateRandomPaths(
11117c6b
 path,
 from = 1,
 to = nrow(path),
 d = ncol(path),
 randomizationParams,
 N
ece1f4ee
 )
 }
 \arguments{
 \item{path}{- This is an mxn dimensional matrix. Each row is
 considered a point.}
 
e6ae102f
 \item{from}{- The starting place along the path which will be
ece1f4ee
 treated as the center of the sphere.  This defaults to 1.}
 
e6ae102f
 \item{to}{- The end point of the path.  This defaults to
ece1f4ee
 nrow(path).}
 
 \item{d}{- The dimension under consideration.  This defaults to
 ncol(path)}
 
5a4f6f2a
 \item{randomizationParams}{- A character vector controling the
 randomization method used.  It's first entry must be either
 'byPermutation' or 'bySteps'  See the vignette for further
 details.}
ece1f4ee
 
 \item{N}{- The number of random paths required.}
 }
 \value{
 This function returns a list of random paths.  Each path is
d7237d68
     a matrix.
ece1f4ee
 }
 \description{
 This function takes a path and produces N random paths of the same
5a4f6f2a
 dimension and length based on it.  This can be done either by
 permuting the entries in path or by taking steps from the initial
 point of path.  Exact behaviour is controlled by
 randomizationParams.
ece1f4ee
 }
d1cdbaf7
 \examples{
5a4f6f2a
 randomizationParams = c('byPermutation','permuteWithinColumns')
2e970a5d
 randomPaths = generateRandomPaths(crooked_path,from=6,to=nrow(crooked_path),
11117c6b
             d=ncol(crooked_path),randomizationParams=randomizationParams,
             N=10)
d1cdbaf7
 }