Last data update: 2014.03.03

R: Sigmoidal transformation of the score values stored in a...
scores2callsR Documentation

Sigmoidal transformation of the score values stored in a cellHTS object obtaining the call values for each probe.

Description

Apply a sigmoidal transformation with parameters z0 and lambda to the summarized scored values stored in a cellHTS object. The obtained results are called calls and are stored in slot assayData, overridding its current content.

Currently this function is implemented only for single-color data.

Usage

scores2calls(x, z0, lambda)

Arguments

x

an object of class cellHTS containing replicate data that have already been scored and summarized (see details).

z0

a numeric value giving the centre of the sigmoidal transformation. See details.

lambda

a numeric value (>0) that corresponds to the parameter lambda of the sigmoidal transformation. This value should be >0, but usually it makes more sense to use a value >=1. See details.

Details

This function applies a sigmoidal transformation with parameters z0 and lambda to the single per-probe score values stored in a cellHTS object. The obtained results are called calls. The transformation is given by:

1 / (1 + exp(-lambda * (z- z0)))

where z are the score values, z0 is the centre of the sigmoidal transformation, and the lambda is a parameter that controls the smoothness of the transformation. The higher is lambda, more steeper is the transition from lower to higher values. lambda should be > 0, but usually it makes more sense to use a value >=1.

This transformation maps the score values to the interval [0,1], and is intended to expand the scale of scores with intermediate values and shrink the ones showing extreme values, therefore making the difference between intermediate phenotypes larger.

Value

The cellHTS object with the call values stored in slot assayData. This is an object of class assayData corresponding to a single matrix of dimensions Features x 1.

Author(s)

W. Huber huber@ebi.ac.uk, Ligia Braz ligia@ebi.ac.uk

References

Boutros, M., Bras, L.P. and Huber, W. (2006) Analysis of cell-based RNAi screens, Genome Biology 7, R66.

See Also

normalizePlates, summarizeChannels, scoreReplicates, summarizeReplicates, imageScreen.

Examples

    data(KcViabSmall)
    x <- normalizePlates(KcViabSmall, scale="multiplicative", method="median", varianceAdjust="none")
    x <- scoreReplicates(x, sign="-", method="zscore")
    x <- summarizeReplicates(x, summary="min")
    xc <- scores2calls(x, z0=1.5, lambda=2) 
    plot(Data(x), Data(xc), col="blue", xlab="z-scores", ylab="calls", main=expression(1/(1+e^{-lambda *(z-z[0])})))
    if(require(splots)) {
     sp = split(Data(xc), plate(xc))
     plotScreen(sp, zrange=c(0,1), fill=c("white", "red"), na.fill="yellow",
               main="Calls", ncol=3L)
    }

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(cellHTS2)
Loading required package: RColorBrewer
Loading required package: Biobase
Loading required package: BiocGenerics
Loading required package: parallel

Attaching package: 'BiocGenerics'

The following objects are masked from 'package:parallel':

    clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,
    clusterExport, clusterMap, parApply, parCapply, parLapply,
    parLapplyLB, parRapply, parSapply, parSapplyLB

The following objects are masked from 'package:stats':

    IQR, mad, xtabs

The following objects are masked from 'package:base':

    Filter, Find, Map, Position, Reduce, anyDuplicated, append,
    as.data.frame, cbind, colnames, do.call, duplicated, eval, evalq,
    get, grep, grepl, intersect, is.unsorted, lapply, lengths, mapply,
    match, mget, order, paste, pmax, pmax.int, pmin, pmin.int, rank,
    rbind, rownames, sapply, setdiff, sort, table, tapply, union,
    unique, unsplit

Welcome to Bioconductor

    Vignettes contain introductory material; view with
    'browseVignettes()'. To cite Bioconductor, see
    'citation("Biobase")', and for packages 'citation("pkgname")'.

Loading required package: genefilter
Loading required package: splots
Loading required package: vsn
Loading required package: hwriter
Loading required package: locfit
locfit 1.5-9.1 	 2013-03-22
Loading required package: grid
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/cellHTS2/scores2calls.Rd_%03d_medium.png", width=480, height=480)
> ### Name: scores2calls
> ### Title: Sigmoidal transformation of the score values stored in a cellHTS
> ###   object obtaining the call values for each probe.
> ### Aliases: scores2calls
> ### Keywords: manip
> 
> ### ** Examples
> 
>     data(KcViabSmall)
>     x <- normalizePlates(KcViabSmall, scale="multiplicative", method="median", varianceAdjust="none")
>     x <- scoreReplicates(x, sign="-", method="zscore")
>     x <- summarizeReplicates(x, summary="min")
>     xc <- scores2calls(x, z0=1.5, lambda=2) 
>     plot(Data(x), Data(xc), col="blue", xlab="z-scores", ylab="calls", main=expression(1/(1+e^{-lambda *(z-z[0])})))
>     if(require(splots)) {
+      sp = split(Data(xc), plate(xc))
+      plotScreen(sp, zrange=c(0,1), fill=c("white", "red"), na.fill="yellow",
+                main="Calls", ncol=3L)
+     }
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>