R: Retrieve summary information on a state

getStateSummary {BoolNet} | R Documentation

## Retrieve summary information on a state

### Description

Returns information on the supplied state, i.e. the successive state after a transition, the (synchronous) attractor to which the state leads, and the distance to this attractor.

### Usage

    getStateSummary(attractorInfo, state)

### Arguments

`attractorInfo` | An object of class `AttractorInfo`, as returned by `getAttractors`, or of class `SymbolicSimulation`, as returned by `simulateSymbolicModel`. As the transition table information in this structure is required, `getAttractors` must be called in synchronous mode and with `returnTable` set to TRUE. Similarly, `simulateSymbolicModel` must be called with `returnGraph=TRUE`.
`state` | A 0-1 vector with n elements (where n is the number of genes in the underlying networks) describing the state.

### Value

Returns a generic dataframe of the class `TransitionTable`. For n genes, the first n columns code for the original state (in this case, the `state` parameter), i.e. each column represents the value of one gene. The next n columns code for the successive state after a transition. The column `attractorAssignment` indicates the attractor to the state is assigned. If this information is available, the column `stepsToAttractor` indicates how many transitions are needed from the original state to the attractor. In this case, the table has only one row describing the supplied state. The `TransitionTable` class supports pretty printing using the `print` method.

### See Also

`getBasinOfAttraction`, `getTransitionTable`, `getAttractors`, `simulateSymbolicModel`

### Examples

    # load example data
    data(cellcycle)

    # get attractors
    attractors <- getAttractors(cellcycle)

    # print information for an arbitrary state
    print(getStateSummary(attractors, c(1,1,1,1,1,1,1,1,1,1)))

[Package BoolNet version 2.1.4 Index]