makeGene            package:GenomeGraphs            R Documentation

_C_r_e_a_t_e_s _a_n _o_b_j_e_c_t _o_f _c_l_a_s_s _G_e_n_e

_D_e_s_c_r_i_p_t_i_o_n:

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

_U_s_a_g_e:

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

_A_r_g_u_m_e_n_t_s:

      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

_V_a_l_u_e:

     An object of class Gene

_A_u_t_h_o_r(_s):

     Steffen Durinck and Jim Bullard

_R_e_f_e_r_e_n_c_e_s:

     ~put references to the literature/web site here ~

_S_e_e _A_l_s_o:

     'gdPlot'

_E_x_a_m_p_l_e_s:

     ##---- 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)
       }

