LocusDefinition-class: Class '"LocusDefinition"'

In sartorlab/chipenrich.data: Companion package to chipenrich

Class "LocusDefinition"

Description

A storage class representing gene locus definitions and their corresponding metadata.

Objects from the Class

Objects can be created by calls of the form new("LocusDefinition"). These objects are used internally by the chipenrich package and users will not likely need to create these.

Slots

dframe:

Object of class "data.frame". Each row represents a locus for a particular geneid.

granges:

Object of class "GenomicRanges". Locus definitions stored as a GenomicRanges object.

genome.build:

Object of class "character". Genome build these definitions were generated from.

organism:

Object of class "character". Organism code.

Note

Not typically accessed by the user - this is used internally by the chipenrich package.

Author(s)

Ryan Welch [e-mail]

Examples

# Show info about the class.
showClass("LocusDefinition");

# Example of what a locus definition object looks like.
data(locusdef.mm9.nearest_tss)
lapply(attributes(locusdef.mm9.nearest_tss), head)

sartorlab/chipenrich.data documentation built on Oct. 4, 2023, 5:21 p.m.