TRACK_META: Get meta data in the current track

In jokergoo/spiralize: Visualize Data on Spirals

Get meta data in the current track

Description

Get meta data in the current track

Usage

TRACK_META

## S3 method for class 'TRACK_META'
names(x)

## S3 method for class 'TRACK_META'
x$name

## S3 method for class 'TRACK_META'
x[[i, exact = TRUE]]

## S3 method for class 'TRACK_META'
x[i]

## S3 method for class 'TRACK_META'
print(x, ...)

Arguments

x	The TRACK_META object.
name	Name of the meta name. For all supported names, type names(TRACK_META).
i	Name of the meta name. For all supported names, type names(TRACK_META).
exact	Please ignore.
...	Additional parameters.

Format

An object of class TRACK_META of length 1.

Details

The variable TRACK_META can only be used to get meta data from the "current" track. If the current track is not the one you want, you can first use set_current_track() to change the current track.

Don't directly use TRACK_META. The value of TRACK_META itself is meaningless. Always use in form of TRACK_META$name.

There are the following meta data for the current track:

• xlim: Data range on x-axis.

• xmin: xlim[1].

• xmax: xlim[2].

• xrange: xlim[2] - xlim[1].

• xcenter: mean(xlim).

• theta_lim: Range of the angles on the spiral, measured in radians.

• theta_min: theta_lim[1].

• theta_max: theta_lim[2].

• theta_range: theta_lim[2] - theta_lim[1].

• theta_center: mean(theta_lim).

• ylim: Data range on y-axis.

• ymin: ylim[1].

• ymax: ylim[2].

• yrange: ylim[2] - ylim[1].

• ycenter: mean(ylim).

• rel_height: Fraction of height of the track to the distance between two neighbouring loops.

• abs_height: The height of the track, which is rel_height multiplied by the distance between two neighbouring loops.

• track_index: Current track index.

Examples

spiral_initialize(xlim = c(0, 1))
spiral_track(ylim = c(0, 1))
for(nm in names(TRACK_META)) {
    cat(nm, ":\n", sep = "")
    print(TRACK_META[[nm]])
    cat("\n")
}
names(TRACK_META)

jokergoo/spiralize documentation built on June 16, 2024, 4:35 a.m.