Trena-class: Define an object of class Trena

Trena-classR Documentation

Define an object of class Trena

Description

The Trena class provides a convenient wrapper for the most commonly used filters and solvers in the trena package. Given a particular genome (one of c("hg38","mm10"), the Trena class provides methods to retrieve information about possible regulators for a target gene, assess the effects of SNPs, and create gene models using the flexible EnsembleSolver class.

Usage

Trena(genomeName, quiet = TRUE)

Arguments

genomeName

A string indicating the genome used by the Trena object. Currently, only human and mouse ( "hg38","mm10") are supported

quiet

A logical indicating whether or not the Trena object should print output

Value

An object of the Trena class

See Also

getRegulatoryChromosomalRegions, getRegulatoryTableColumnNames, getGeneModelTableColumnNames, createGeneModelFromRegulatoryRegions, createGeneModelFromTfList

Examples

# Create a Trena object using the human hg38 genome
trena <- Trena("hg38")


PriceLab/trena documentation built on March 16, 2023, 10:01 a.m.