showIsoforms: Display Isoform Annotation

View source: R/getIsoData.R

showIsoformsR Documentation

Display Isoform Annotation

Description

Display and filter isoform annotation and find those associated with given genes.

Usage

showIsoforms(
  x,
  isoforms = NULL,
  genes = NULL,
  annotation = FALSE,
  appris = NULL,
  transcriptType = NULL,
  symbol = "GeneSymbol",
  ttype = "transcript_type",
  ...
)

Arguments

x

R data object with stored isoform annotation data; Most typically this is an ExpressionSet there is support for other datatypes as well.

isoforms

character; A vector of isoform IDs to include in the output. Can be used in combination with with genes.

genes

character; A vector of gene symbols. Will include isoforms associated with the genes listed in addition to the isoforms listed in the isoforms option. The symbol option controls the column used in the gene symbol look up.

annotation

boolean or vector; If set to TRUE all annotation will be listed. Numeric or character vectors can be supplied to subset the anntation columns as desired. Default is FALSE

appris

boolean or character; If set to TRUE, will return only isoforms with appris annotation. If set to a character string, will restirct isoforms to those with the character value matching a substring of the appris tag. Appris collumn is determined by the first collumn name to containing 'Appris' (case insenstive).

transcriptType

character; Returns only those isoforms where the transcript type collumn has a substring that matches the character value supplied such as 'protein' in 'protein_coding'. The transcript type collumn is determined by the ttype option.

symbol

character; Column name of the optional gene symbols column in the annotation. The default value is 'GeneSymbol'.

ttype

character; Column name of the optional transcript type column in the annotation. The default value is 'transcript_type'.

...

additional parameters for S3 variants.

Details

This is a convenience function that will pull out isoform annotation from popular Bioconductor classes. The isoforms can be selected by name and/or by thier association with a particular gene or genes. If nothing else is specified, only the isoform IDs are returned. Isoforms can be filtered by appris or transcriptType. If the appris option is set to TRUE, only isoforms with some type of appris annotation will be returned. If it is set to a charater string such as 'principal', it will only return isoforms where that value is a substring of the appris tag. The appris ID collumn, if it exisits, is identified by looking for 'appris' (case insensitive) in the annotation column names. The other filter, transcriptType, returns only those isoforms where the transcript type tag contains the value as a subtring. Finally, if annotation is set to TRUE, all annotation collumn are included with the output. If a character or numeric vector is supplies, they will be used to filter the columns.

Note that this can also be run with gene level data to return gene IDs based on gene symbol.

Value

a vector of isoform IDs or a dataframe of isoform IDs with requested annotation.

See Also

isoPlot

Examples

ToDo<-1


ZachHunter/bvt documentation built on Sept. 18, 2024, 3:12 p.m.