get.movements: Summarize Detected Movements

Description Usage Arguments Value Author(s) References See Also

View source: R/hbm.R

Description

get.movements summarizes the results of detect.movement.

Usage

1
get.movements(movement, hm, features = NULL)

Arguments

movement

numeric matrix computed with detect.movement.

hm

a hierarchical block matrix computed with hbm, with:
hm_{i,j} = the minimal scale (iteration) at which i and j were clustered together, or 0 if i=j

features

one or more feature matrices computed with hbm.features, used to indicate if the movement is detected within a robust feature. Set to NULL by default. When more than one matrix is provided features should be a list of matrices.

Value

get.movements returns a data frame with the following columns:
from: the moving node,
to: the node that from has moved towards or away from,
type: one of the following values: (-1.0, 0.5, 0.5, 1) where -1 indicates from moved away from to, 1 indicates from moved towards to, and -0.5 and 0.5 indicate possible/implicated movements correspondingly,
scale: the scale at which the movement was detected, and
robust an optional column (when features is not NULL) with 1 for non-NA elements in the features matrix, and 0 otherwise.

Author(s)

Yoli Shavit

References

hbm's website: http://www.cl.cam.ac.uk/~ys388/hbm/

See Also

detect.movement to see how changes between chains are detected
hbm to learn how to build hierarchical block matrices
hbm's tutorials at http://www.cl.cam.ac.uk/~ys388/hbm/


hbm documentation built on May 29, 2017, 9:06 a.m.