plateClassificationMethod {twoddpcr} | R Documentation

## Set or retrieve the classification method strings for multiple wells.

### Description

`plateClassificationMethod` retrieves multiple classification methods that have been assigned to a `ddpcrPlate` object.

`commonClassificationMethod` retrieves the classification methods common to all the wells in the given `ddpcrPlate` object.

### Usage

    plateClassificationMethod(theObject)

    ## S4 method for signature 'ddpcrPlate'
    plateClassificationMethod(theObject)

    plateClassificationMethod(theObject, cMethod) <- value

    ## S4 replacement method for signature 'ddpcrPlate'
    plateClassificationMethod(theObject, cMethod) <- value

    commonClassificationMethod(theObject)

    ## S4 method for signature 'ddpcrPlate'
    commonClassificationMethod(theObject)

### Arguments

`theObject` | A `ddpcrPlate` object.
`cMethod` | This should represent existing classification method(s) for all wells in `theObject`. It can be given in the form of a: Character vector. If this vector is shorter than the length of `wells`, this vector's elements will be repeated. List of character vectors.
`value` | New classification method(s) in the same form as `cMethod`.

### Value

`plateClassificationMethod` returns a list of character strings corresponding to the classification methods.

`commonClassificationMethod` returns a vector of character strings indicating which classification methods appear in all wells.

### Author(s)

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

### See Also

`plateClassification` for the classifications.

### Examples

    ## Get the classification methods for the KRASdata dataset.
    krasPlate <- ddpcrPlate(wells=KRASdata)
    plateClassificationMethod(krasPlate)

    ## Change the "Cluster" column to "QS".
    plateClassificationMethod(krasPlate, "Cluster") <- "QS"
    plateClassificationMethod(krasPlate)

    ## Usually, all of the classification names are the same for all wells. We
    ## use the \code{commonClassificationMethod} method to retrieve the ones
    ## common to all wells.
    commonClassificationMethod(krasPlate)

[Package twoddpcr version 1.12.0 Index]