track_scalebar {rGenomeTracks}

R Documentation

Generate scalebar track

Description

scalebar track is a track with a stretch that highlights specific distance on the genomic coordiantes

Usage

track_scalebar(
  title = NULL,
  height = 2,
  overlay_previous = "no",
  where = "left",
  fontsize = 12,
  line_width = 0.5,
  color = "black",
  alpha = 1,
  x_center = NULL,
  size = NULL,
  scalebar_start_position = NULL,
  scalebar_end_position = NULL
)

Arguments

title	String. If specificed, the title of the track to be displayed.
height	Numeric. The height of the plotted track in cm. Default is 2. See notes.
overlay_previous	String. Options are "no" (default) or "yes" or "share-y".
where	"left" (default), "right", "top" or "bottom".
fontsize	Numeric value to font size of tracks's text.
line_width	0.5 (default) or any float above 0.
color	String. Hex color or string color. Default is "#1f78b4".
alpha	Numeric variable between 0 and 1 to indicate level of transparancy. Default is 1.
x_center	Numeric value above 0. Default is NULL.
size	Numeric value above 0. Default is NULL.
scalebar_start_position	Numeric value above 0. Default is NULL.
scalebar_end_position	Numeric value above 0. Default is NULL.

Value

genome_track

Note

fontsize argument can be overriden by the same argument in plot_gtracks()

Author(s)

Omar Elashkar

Examples

np_bed_dir <- system.file("extdata", "test2.narrowPeak", package = "rGenomeTracks")

tracks <-
  track_scalebar(
    scalebar_start_position = 2785 * 10^3,
    scalebar_end_position = 2799 * 10^3
  ) +
  track_narrow_peak(np_bed_dir,
    title = "peak type with summit",
    height = 3,
    type = "peak",
    color = "green"
  ) + track_x_axis()
## Not run: 
plot_gtracks(tracks, chr = "X", start = 276 * 10^4, end = 280 * 10^4, trackLabelFraction = 0.2)

## End(Not run)

---