makeGene: Creates an object of class Gene

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

View source: R/GenomeGraphs-classes.R

Description

Creates an object of class Gene. This represents a gene structure as annotated in Ensembl.

Usage

1
makeGene(id, type, biomart, dp = NULL)

Arguments

id

An identifier used to specify of which gene the intron-exon structure should be retrieved

type

The type of identifiers used, examples are ensembl\_gene\_id, hgnc\_symbol,entrezgene. See listAttributes function of the biomaRt package for more info

biomart

Mart object, created by the useMart function of biomaRt

dp

object of class DisplayPars, determines the display of features on the plot

Value

An object of class Gene

Author(s)

Steffen Durinck and Jim Bullard

References

~put references to the literature/web site here ~

See Also

gdPlot

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (id, type, biomart, dp = NULL) 
{
    if (missing(id)) 
        stop("Need to specify a gene identifier for creating a Gene")
    pt <- getClass("Gene")@prototype
    if (is.null(dp)) 
        dp <- pt@dp
    if (missing(type)) 
        type = pt@type
    new("Gene", id = id, type = type, biomart = biomart, dp = dp)
  }

GenomeGraphs documentation built on Oct. 31, 2019, 4:34 a.m.