normSights {sights} | R Documentation

## Normalization methods

### Description

Apply any of the available SIGHTS normalization methods

### Usage

    normSights(normMethod, dataMatrix, plateRows, plateCols, dataRows = NULL,
      dataCols = NULL, trimFactor = 0.2, wellCorrection = FALSE,
      biasMatrix = NULL, biasCols = NULL, seqFilter = TRUE)

### Arguments

`normMethod` | Normalization method name from SIGHTS ('Z', 'RobZ', 'R', 'SPAWN', 'Loess', or 'MedFil')
`dataMatrix` | Data frame or numeric matrix. Columns are plates, and rows are plate wells.
`plateRows, plateCols` | Number of rows/columns in plate. Applies to normMethods 'R', 'SPAWN', 'Loess', and 'MedFil'.
`dataRows, dataCols` | Optional integer vector. Indicate which row/column numbers from the dataMatrix should be normalized. If NULL then all rows/columns from the dataMatrix are used.
`trimFactor` | Optional trim value to be used in trimmed mean polish. It should be between 0 and 0.5. Default is 0.2. Applies to normMethod 'SPAWN'.
`wellCorrection` | Optional logical. If TRUE then individual wells are corrected based on spatial bias. Applies to normMethod 'SPAWN'.
`biasMatrix` | Optional data frame or numeric matrix, in the same format as dataMatrix and with the same plateRows and plateCols specifications. If NULL then normalized data is used as bias template. Applies to normMethod 'SPAWN'.
`biasCols` | Optional integer vector. Indicate which column numbers from biasMatrix or normalized dataMatrix (subset of dataCols) should be used to calculate bias template. Control plates or selection of dataMatrix plates to be used for well correction. If NULL then all plates of biasMatrix or normalized dataMatrix are used. Applies to normMethod 'SPAWN'.
`seqFilter` | Optional logical. If TRUE apply initial row median filter then standard filter, else just apply standard filter. Applies to normMethod 'MedFil'.

### Details

One of the following SIGHTS normalization methods may be chosen: `normZ`, `normRobZ`, `normR`, `normSPAWN`, `normLoess`, or `normMedFil`. See their individual help pages for more details.

### Value

Numeric matrix of normalized data in the same format as dataMatrix

### Note

For information on how to arrange your dataset for dataMatrix, please see (`ex_dataMatrix`)

### References

Murie et al. (2015). Improving detection of rare biological events in high-throughput screens. Journal of Biomolecular Screening, 20(2), 230-241.

### See Also

Other SIGHTS functions: `plotSights`, `statSights`

### Examples

    ## load dataset
    data(ex_dataMatrix)

    ## choose a normalization method and provide relevant information
    ex_normMatrix <- normSights(dataMatrix = ex_dataMatrix, dataCols = 5:10,
    normMethod = 'RobZ')

[Package sights version 1.20.0 Index]