tntboard: TnTBoard

In Marlin-Na/TnT: Interactive Visualization for Genomic Features

TnTBoard

Description

A TnTBoard or TnTGenome object stores a list of tracks and can be automatically shown in an interactive R session or in rmarkdown output.

Usage

TnTBoard(
  tracklist,
  view.range = GRanges(),
  coord.range = IRanges(),
  zoom.allow = IRanges(),
  allow.drag = TRUE,
  use.tnt.genome = FALSE
)

TnTGenome(
  tracklist,
  view.range = GRanges(),
  coord.range = IRanges(),
  zoom.allow = IRanges(),
  allow.drag = TRUE
)

Arguments

tracklist	One track or a list of tracks to view.
view.range	Length-one GRanges object, sets the initial view range.
coord.range	Length-one IRanges object or length-two numeric vector, sets the coordinate limit of the board (i.e. minimum/maximum possible coordinate).
zoom.allow	Length-one IRanges object or length-two numeric vector, sets the minimum and maximum extent of the board (i.e. the limit when zooming in and zooming out).
allow.drag	Logical, whether drag should be allowed? Default TRUE.
use.tnt.genome	Logical, whether to add axis and location. 'TnTGenome(...)' is essentially a wrapper to 'TnTBoard(..., use.tnt.genome = TRUE)'.

Value

Returns a TnTBoard or TnTGenome object which has printing method to be rendered as a htmlwidget.

Examples

track <- BlockTrack(GRanges("chr1", IRanges(start = c(100, 300, 500), width = c(10, 100, 200))))
## Not run: 
TnTGenome(track)

## End(Not run)

Marlin-Na/TnT documentation built on Sept. 15, 2024, 5:27 a.m.