gen_progindex: Compute the progress index along with parent and...

Description Usage Arguments Details Value Examples

View source: R/gen_progindex.R

Description

This function is able to create the progrex index of a time series from its minimum spanning tree of the distances. In order to understand how the progrex index is generated please refer to http://www.sciencedirect.com/science/article/pii/S0010465513002038.

Usage

1
gen_progindex(adjl = NULL, nsnaps = NULL, snap_start = 1)

Arguments

adjl

A list of three elements: degree list, connectivity matrix and weights. This input must be a minimum spanning tree, otherwise the function will not be able to resolve the progress index in a unique solution. If backend netcdf data handling is active, this input can be left empty. In this case please set the general option CampaR1.data_management="netcdf".

nsnaps

Number of snashots in the trajectory. If adjl is inserted this specification is not necessary. Instead if the netcdf backend data handling is active this value will be necessary and precise in order to avoid unpredictable behaviours.

snap_start

The snapshot from which the progrex index will start.

Details

For details, please refer to the main documentation of the original campari software http://campari.sourceforge.net/documentation.html.

Value

The output of this function MUST be used as input for the gen_annotation function.

Examples

1
2
adjl <- mst_from_trj(trj = matrix(rnorm(1000), nrow = 100, ncol = 10))
ret <- gen_progindex(adjl = adjl)

CampaR1 documentation built on May 30, 2017, 2:51 a.m.