clusterCentres {twoddpcr} | R Documentation

## Retrieve the cluster centres.

### Description

`clusterCentres` retrieves the cluster centres for a `ddpcrWell` object or the centres for each well in a `ddpcrPlate` object.

`combinedCentres` retrieves the cluster centres for all of the wells together.

### Usage

    clusterCentres(theObject, cMethod)

    ## S4 method for signature 'ddpcrWell'
    clusterCentres(theObject, cMethod)

    ## S4 method for signature 'ddpcrPlate'
    clusterCentres(theObject, cMethod)

    combinedCentres(theObject, cMethod)

    ## S4 method for signature 'ddpcrPlate'
    combinedCentres(theObject, cMethod)

### Arguments

`theObject` | A `ddpcrWell` or `ddpcrPlate` object.
`cMethod` | The classification method for which to obtain the centres.

### Value

If a `ddpcrWell` object is given, `clusterCentres` returns the cluster centres as a data frame.

If a `ddpcrPlate` object is given, `clusterCentres` return a list of data frames, where each data frame corresponds to the cluster centres of a well.

`combinedCentres` returns a data frame of the centres of all of the wells combined.

### Author(s)

Anthony Chiu, anthony.chiu@cruk.manchester.ac.uk

### Examples

    ## Get the centres of a sample with 4 clusters.
    aWell <- ddpcrWell(well=KRASdata[["E03"]])
    clusterCentres(aWell, "Cluster")

    ## Get the centres of a sample with 3 clusters.
    aWell <- ddpcrWell(well=KRASdata[["H04"]])
    clusterCentres(aWell, "Cluster")

    ## Retrieve the cluster centres of each of the wells in a \code{ddpcrPlate}
    ## object.
    krasPlate <- ddpcrPlate(wells=KRASdata)
    clusterCentres(krasPlate, cMethod="Cluster")

    ## Retrieve the cluster centres of all wells combined.
    combinedCentres(krasPlate, cMethod="Cluster")

[Package twoddpcr version 1.18.0 Index]