interacCircos (version 1.0.0)

CircosText: Create Text module to be added to a moduleList

Description

Simple text annotation displayed in the visualization

Usage

CircosText(
  modulename,
  text,
  x = 0,
  y = 0,
  size = "1.2em",
  weight = "bold",
  opacity = 1,
  color = "#000000",
  rotateRate = 0,
  animationDisplay = FALSE,
  animationInitialSize = 20,
  animationInitialWeight = "bold",
  animationInitialColor = "black",
  animationInitialOpacity = 1,
  animationInitialPositionX = 0,
  animationInitialPositionY = 0,
  animationInitialRotate = 0,
  animationDelay = 50,
  animationTime = 1000,
  animationType = "linear",
  ...
)

Arguments

modulename

The name of the new module.

text

The text to be displayed.

x, y

Coordinates of the lower left corner of the annotation

size

Font size, with units specified (such as em or px).

weight

Font weight. Can be "normal", "bold", "bolder" or "lighter".

opacity

Font opacity.

color

Font color, in hexadecimal RGB format.

rotateRate

ratate rate for text

animationDisplay

Whether display a animation or not

animationInitialSize

Initial text size in animation

animationInitialWeight

Initial text weight in animation

animationInitialColor

Initial text color in animation

animationInitialOpacity

Initial text opacity in animation

animationInitialPositionX, animationInitialPositionY

Initial text coordinates in animation(The parameter x,y will become the final position for text if animation displayed)

animationInitialRotate

Initial rotate rate in animation

animationTime, animationDelay, animationType

The time, delay and display type for animation

...

Ignored

Value

The module tracks for text modules.

Examples

# NOT RUN {
Circos(CircosText('text01', 'Annotation', color = '#DD2222', x = -40))

# }