prepare_gp3tools_sequences: Prepare common gp3tools-style sequence outputs

View source: R/sequence-adapters.R

prepare_gp3tools_sequencesR Documentation

Prepare common gp3tools-style sequence outputs

Description

This optional compatibility helper recognises ordinary data frames or lists containing a data-frame component and maps common sequence-column names to the neutral gp3sequences contract. It does not require a gp3tools class.

Usage

prepare_gp3tools_sequences(
  data,
  sequence_id_col = NULL,
  order_col = NULL,
  state_col = NULL,
  duration_col = NULL,
  metadata_cols = NULL,
  ...
)

Arguments

data

A data frame or list with a data-frame data component.

sequence_id_col, order_col, state_col

Optional explicit mappings.

duration_col

Optional duration mapping.

metadata_cols

Optional constant-within-sequence metadata columns.

...

Additional arguments passed to prepare_sequence_data().

Value

A standard gp3sequences preparation result.

Examples

sequences <- data.frame(
  sequence_id = rep(c("s1", "s2", "s3", "s4"), each = 4L),
  sequence_order = rep(1:4, times = 4L),
  state = c("A", "B", "C", "D", "A", "B", "C", "C",
            "D", "C", "B", "A", "D", "C", "A", "A"),
  group = rep(c("g1", "g2"), each = 8L),
  stringsAsFactors = FALSE
)
names(sequences)[names(sequences) == "sequence_order"] <- "position"
names(sequences)[names(sequences) == "state"] <- "aoi_label"
prepare_gp3tools_sequences(sequences)


gp3sequences documentation built on Aug. 23, 2026, 5:10 p.m.