set_labels: Add labels

In pmcharrison/hrep: Harmony Representations

Add labels

Description

Adds labels to an object, typically for plotting purposes.

Usage

set_labels(x, labels)

## S3 method for class 'sparse_spectrum'
set_labels(x, labels)

Arguments

x	Object.
labels	Character vector of labels to add to the object. In the case of sparse spectra, there should be one label for each partial.

Value

The original object, with labels added.

Examples

spectrum <- sparse_pi_spectrum("60 64 67", num_harmonics = 1)
labels <- as.character(c(1, 2, 3))
spectrum_with_labels <- set_labels(spectrum, labels)
plot(spectrum_with_labels)

pmcharrison/hrep documentation built on Feb. 18, 2024, 2:33 a.m.