rnb.get.annotation: rnb.get.annotation
In RnBeads: RnBeads
Description
Usage
Arguments
Details
Value
Author(s)
See Also
Examples
Description
Extracts the requested annotation for the given genome.
Usage
1
rnb.get.annotation(type = "CpG", assembly = "hg19")
Arguments
type
Name of annotation.
assembly
Genome assembly of interest. See rnb.get.assemblies for the list of supported genomes.
Details
When the returned value is of type GRangesList, it defines the genomic positions of the requested sites,
probes or regions. Identifiers, if present, can be obtained using the names method. Strand information is also
included when applicable. Any additional annotation is stored as metadata in the respective GRanges objects.
Value
Probe, site or region annotation table. If the specified type refers to control probes, the returned value is
a data.frame listing all respective control probes. Otherwise, this function returns an object of type
GRangesList - a list of consistent GRanges objects, one per chromosome.
Author(s)
Fabian Mueller
See Also
rnb.set.annotation for adding annotation;
rnb.region.types for all loaded region types in a genome assembly
Examples
1
rnb.get.annotation("promoters")
RnBeads documentation built on March 3, 2021, 2 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value Author(s) See Also Examples
Description
Extracts the requested annotation for the given genome.
Usage
1 | rnb.get.annotation(type = "CpG", assembly = "hg19")
|
Arguments
type |
Name of annotation. |
assembly |
Genome assembly of interest. See |
Details
When the returned value is of type GRangesList, it defines the genomic positions of the requested sites,
probes or regions. Identifiers, if present, can be obtained using the names method. Strand information is also
included when applicable. Any additional annotation is stored as metadata in the respective GRanges objects.
Value
Probe, site or region annotation table. If the specified type refers to control probes, the returned value is
a data.frame listing all respective control probes. Otherwise, this function returns an object of type
GRangesList - a list of consistent GRanges objects, one per chromosome.
Author(s)
Fabian Mueller
See Also
rnb.set.annotation for adding annotation;
rnb.region.types for all loaded region types in a genome assembly
Examples
1 | rnb.get.annotation("promoters")
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.