setInfo: Adding Information In An Object Of Class '"rCGH"'

Description Usage Arguments Value Warning Author(s) See Also Examples

Description

This function allows the user to store any type of supplementaty information in an object of class "rCGH".

Usage

1
2
## S4 replacement method for signature 'rCGH'
setInfo(object, item = NULL) <- value

Arguments

object

: An object of class "rCGH"

item

: character. An item name to store. Default is NULL.

value

: any. A value to store.

Value

An object of class "rCGH"

Warning

When either item or value is NULL, an error is returned.

Author(s)

Frederic Commo

See Also

getInfo

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
filePath <- system.file("extdata", "Affy_cytoScan.cyhd.CN5.CNCHP.txt.bz2",
    package = "rCGH")
cgh <- readAffyCytoScan(filePath, sampleName = "AffyScHD")

# When supplementary information is added,
# numerical, logical, or strings are supported
setInfo(cgh, "someItem1") <- 35
setInfo(cgh, "someItem2") <- TRUE
setInfo(cgh, "someItem3") <- "someComment"
getInfo(cgh)

# or to get back specific items
getInfo(cgh, c("someItem1", "someItem3"))

rCGH documentation built on Nov. 8, 2020, 8:30 p.m.