NetAffxResource-class {AffyCompatible} | R Documentation

## Manage NetAffx annotations

### Description

This class is for accessing and retrieving NetAffx annotation files for Affymetrix chips. It requires that the user has established an account with Affymetrix. Detailed usage is described in the `Annotations with NetAffx' vignette.

### Objects from the Class

Objects are created by calls of the form `NetAffxResource(user="user@research.org", password="terces")`, as illustrated below and in the `Annotations with NetAffx vignette.

### Slots

`user`:
  Object of class `"character"` containing the full user name (typically an email address) obtained when the user registers with Affymetrix.
`password`:
  Object of class `"character"` containing the password associated with the Affymetrix user name. The password is entered and stored in plain text, and should not be considered secure within Bioconductor.
`affxLicence`:
  Object of class `"character"` containing the licence, obtained from Affymetrix, for retrieving NetAffx annotations. The licence is usually software specific (e.g., for the AffyCompatible package of Bioconductor). Users will not usually change the defeault value.
`directory`:
  Object of class `"character"`, containing the local directory path where the NetAffx data base and annotation files will reside.
`annotationsFile`:
  Object of class `"character"` containing the file name of the NetAffx data base. Users will not usually change the default value.
`affxUrl`:
  Object of class `"character"` containing the URL used to download the NetAffx annotations file. Users will not usually change the default value.

### Extends

Class `"NetAffxCompatibility"`, directly. Class `"AffyCompatible"`, by class "NetAffxCompatibility", distance 2.

### Methods

[[
  `signature(x = "NetAffxResource", i = "numeric", j = "missing")`
[[
  `signature(x = "NetAffxResource", i = "character", j = "missing")`: Retrieve an object representing all NetAffx annotations available for an array. The argument `i` may be a numeric index or character string corresponding to an array name returned by `names(x)`.
[[
  `signature(x = "NetAffxResource", i = "numeric", j = "numeric")`
[[
  `signature(x = "NetAffxResource", i = "character", j = "numeric")`
[[
  `signature(x = "NetAffxResource", i = "numeric", j = "character")`
[[
  `signature(x = "NetAffxResource", i = "character", j = "character")`: Retrieve an object representing a specific annotation for an array. The argument `i` may be a numeric index or character string corresponding to an array name returned by `names(x)`. The argument `i` may be a numeric index or character string corresonding to an annotation returned by `description(x[[i]])`.
affxLicence
  `signature(x = "NetAffxResource")`: the character string representation of the licence used to access the NetAffx site.
affxUrl
  `signature(x = "NetAffxResource")`: the url used to access the NetAffx site.
annotationsFile
  `signature(x = "NetAffxResource")`: the file name of NetAffx data base, as stored on the local disk of the user.
directory
  `signature(x = "NetAffxResource")`: the directory in wich the NetAffx data base and annotation files are stored on the local disk of the user.
names
  `signature(x = "NetAffxResource")`: the names of the arrays for which annotations are available.
password
  `signature(x = "NetAffxResource")`: The password associated with the user name obtained when the user registered with Affymetrix. The password is entered and stored as plain text, and is not secure.
readAnnotation
  `signature(netAffxResource = "NetAffxResource", array = "numeric", annotation = "numeric", ...)`
readAnnotation
  `signature(netAffxResource = "NetAffxResource", array = "numeric", annotation = "character", ...)`
readAnnotation
  `signature(netAffxResource = "NetAffxResource", array = "character", annotation = "numeric", ...)`
readAnnotation
  `signature(netAffxResource = "NetAffxResource", array = "character", annotation = "character", ...)`
readAnnotation
  `signature(netAffxResource = "NetAffxResource", array = "missing", annotation = "AffxAnnotation", ...)`: Read a specific anntotation file as an R object. for the first four methods, `array`, if present, indexes or names the array while `annotation` indexes or names the annotation. All methods also accept `content = "logical"` to indicate whether the content of the file should be returned if possible (`content=TRUE`, default) or only the path to the local file (`content=FALSE`) and `update = "logical"` indicating whether the file should be read from disk if available (`update=FALSE`, default) or retrieved from the NetAffx web site (`update=TRUE`). `readAnnotation` parses `CSV, Tabular, PSI` to data frames, and reads `FASTA` files to a list of description / sequence pairs (see `Biostrings::readFASTA`).
show
  `signature(object = "NetAffxResource")`: compactly show the `NetAffxResource` object.
user
  `signature(x = "NetAffxResource")`: The user name (typcially email address) obtained when the user registers with the Affymetrix web site.

### Author(s)

Martin Morgan <mtmorgan@fhcrc.org>

### See Also

Vignette `Annotations with NetAffx'. Affymetrix user login site https://www.affymetrix.com/site/login/login.affx.

`.Rprofile` for ways to automatically set variables (such as `password`, and `directory`) for each session.

### Examples

    ## password must be obtained by the user
    rsrc <- NetAffxResource(user="mtmorgan@fhcrc.org", password=password)
    head(names(rsrc))
    affxDescription(rsrc[["Bovine"]])
    ## paradigm to display all elements of 'annotation'
    sapply(affxAnnotation(rsrc[["Bovine"]]), force)
    ## obtain and read a single annotation
    anno <- rsrc[["Porcine", "BLASTP annotations, CSV Format"]]
    df <- readAnnotation(rsrc, annotation=anno)

[Package AffyCompatible version 1.2.0 Index]