Creates an object of class "ROC" which can be plotted as a ROC curve

Description

The function ROC construct an object of S3 class ROC, which represents a receiver-operator-characteristic curve, from the data of the annotated positive and negative controls in a scored cellHTS object.

Usage

ROC(x, positives, negatives)
## S3 method for class 'ROC'
plot(x, col="darkblue", type="l", main = "ROC curve", ...)
## S3 method for class 'ROC'
lines(x, ...)

Arguments

Details

The cellHTS object x must contain a slot called score, and selection proceeds from large to small values of this score. Furthermore, x is expected to contain positive and negative controls annotated in the slot wellAnno with the values of the arguments positives and negatives, respectively. If the assay is a two-way experiment, positives should be a list with components act and inh, specifying the name of the activators, and inhibitors, respectively. In this case, the ROC cureve is constructed based on the absolute values of x$score.

Value

An S3 object of class ROC. There are methods plot.ROC and lines.ROC.

Author(s)

Ligia P. Bras ligia@ebi.ac.uk

Examples

    data(KcViabSmall)
    ## Not run: 
    x <- normalizePlates(KcViabSmall, normalizationMethod="median", zscore="-")
    x <- summarizeReplicates(x)
    y <- ROC(x)
    plot(y)
    lines(y)
    
## End(Not run)

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(cellHTS)
Loading required package: grid
Warning message:
Package 'cellHTS' is deprecated and will be removed from Bioconductor
  version 3.4. Please consider using 'cellHTS2' which offers better
  functionality for working with multiple screens and with
  multi-channel screens. 
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/cellHTS/ROC.Rd_%03d_medium.png", width=480, height=480)
> ### Name: ROC
> ### Title: Creates an object of class "ROC" which can be plotted as a ROC
> ###   curve
> ### Aliases: ROC plot.ROC lines.ROC
> ### Keywords: univar
> 
> ### ** Examples
> 
>     data(KcViabSmall)
>     ## Not run: 
> ##D     x <- normalizePlates(KcViabSmall, normalizationMethod="median", zscore="-")
> ##D     x <- summarizeReplicates(x)
> ##D     y <- ROC(x)
> ##D     plot(y)
> ##D     lines(y)
> ##D     
> ## End(Not run)
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>