applyStaggered: Compute a Measure on a Track in a Staggered Fashion
In celltrackR: Motion Trajectory Analysis
applyStaggered R Documentation
Compute a Measure on a Track in a Staggered Fashion
Description
Computes a measure on all subtracks of a track and return them either
as a matrix or return their mean.
Usage
applyStaggered(x, measure, matrix = FALSE, min.segments = 1)
Arguments
x
the track for which the measure is to be computed.
measure
the measure that is to be computed.
matrix
a logical indicating whether the whole matrix of values for
the measure for each of the input track's subtracks is to be returned.
Otherwise only the mean is returned.
min.segments
the number of segments that each regarded subtrack
should at least consist of. Typically, this value would be set to the
minimum number of segments that a (sub)track must have in order for the
measure to be decently computed. For example, at least two segments are needed
to compute the overallAngle.
Details
The measure is computed for each of the input track's subtracks of
length at least min.segments, and the resulting values are either
returned in a matrix (if matrix is set), or their mean is returned.
The computed matrix is symmetric since the direction along which a
track is traversed is assumed not to matter. The values at
[i, i + j], where j is a nonnegative integer with
j < min.segments, (with the default value min.segments=1
this is exactly the main diagonal) are set to NA.
Value
If matrix is set, a matrix with the values of the measure for
all the input track's subtracks is returned. The value of this matrix at
position [i, j] corresponds to the subtrack that starts with the input track's
jth point and ends at its ith. Thus, with increasing column number,
the regarded subtrack's starting point is advanced on the original track,
and the values for increasingly long subtracks starting from this point can
be found columnwise below the main diagonal, respectively.
If 'matrix' is not set, the mean over the values of the measure for all
subtracks of at least 'min.segments' segments is retruned.
Examples
## Compute the staggered matrix for overallAngle applied to all long enough
## subtracks of the first T cell track
applyStaggered(TCells[[1]], overallAngle, matrix=TRUE, min.segments = 2)
celltrackR documentation built on March 21, 2022, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| applyStaggered | R Documentation |
Compute a Measure on a Track in a Staggered Fashion
Description
Computes a measure on all subtracks of a track and return them either as a matrix or return their mean.
Usage
applyStaggered(x, measure, matrix = FALSE, min.segments = 1)
Arguments
x |
the track for which the measure is to be computed. |
measure |
the measure that is to be computed. |
matrix |
a logical indicating whether the whole matrix of values for the measure for each of the input track's subtracks is to be returned. Otherwise only the mean is returned. |
min.segments |
the number of segments that each regarded subtrack
should at least consist of. Typically, this value would be set to the
minimum number of segments that a (sub)track must have in order for the
measure to be decently computed. For example, at least two segments are needed
to compute the |
Details
The measure is computed for each of the input track's subtracks of
length at least min.segments, and the resulting values are either
returned in a matrix (if matrix is set), or their mean is returned.
The computed matrix is symmetric since the direction along which a
track is traversed is assumed not to matter. The values at
[i, i + j], where j is a nonnegative integer with
j < min.segments, (with the default value min.segments=1
this is exactly the main diagonal) are set to NA.
Value
If matrix is set, a matrix with the values of the measure for
all the input track's subtracks is returned. The value of this matrix at
position [i, j] corresponds to the subtrack that starts with the input track's
jth point and ends at its ith. Thus, with increasing column number,
the regarded subtrack's starting point is advanced on the original track,
and the values for increasingly long subtracks starting from this point can
be found columnwise below the main diagonal, respectively.
If 'matrix' is not set, the mean over the values of the measure for all
subtracks of at least 'min.segments' segments is retruned.
Examples
## Compute the staggered matrix for overallAngle applied to all long enough ## subtracks of the first T cell track applyStaggered(TCells[[1]], overallAngle, matrix=TRUE, min.segments = 2)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.