annotationRegions: Get the annotation of SNP regions for a _SNPhood_ object.

Description Usage Arguments Value Examples

View source: R/core.R

Description

Return the annotation of the SNP regions that are defined in the SNPhood object.

Usage

1
annotationRegions(SNPhood.o, asGRangesObj = FALSE, verbose = FALSE)

Arguments

SNPhood.o

Object of class SNPhood

asGRangesObj

Logical(1). Default FALSE. Should the full annotation be returned (as GRanges object) or only the annotation of the SNP regions (as character vector)?

verbose

Logical(1). Default FALSE. Should the verbose mode (i.e., diagnostic messages during execution of the script) be enabled?

Value

If asGRangesObj is set to TRUE, a GRanges object is returned. Otherwise, a character vector with the currently stored SNP annotation is returned.

Examples

1
2
3
data(SNPhood.o, package="SNPhood")
IDs.vec = annotationRegions(SNPhood.o, asGRangesObj = FALSE)
IDs.gr  = annotationRegions(SNPhood.o, asGRangesObj = TRUE)

SNPhood documentation built on May 31, 2017, 11:01 a.m.

Search within the SNPhood package
Search all R packages, documentation and source code