filter_sequence_subsequences: Filter non-contiguous subsequence summaries

View source: R/sequence-subsequences.R

filter_sequence_subsequencesR Documentation

Filter non-contiguous subsequence summaries

Description

Filter non-contiguous subsequence summaries

Usage

filter_sequence_subsequences(
  summary,
  min_sequences = 1L,
  min_prevalence = 0,
  max_mean_gap = Inf,
  top_n = NULL,
  ties = c("include", "exclude")
)

Arguments

summary

A data frame from summarise_sequence_subsequences().

min_sequences

Minimum sequence count.

min_prevalence

Minimum sequence prevalence.

max_mean_gap

Optional maximum mean gap.

top_n

Optional number of rows retained after deterministic sorting.

ties

Include or exclude ties at the top_n boundary.

Value

A filtered summary data frame.

Examples

data <- data.frame(sequence_id = rep(c("a", "b"), each = 4L),
                   sequence_order = rep(1:4, 2L),
                   state = c("A", "B", "C", "D", "A", "C", "B", "D"))
x <- summarise_sequence_subsequences(extract_sequence_subsequences(data))
filter_sequence_subsequences(x, min_sequences = 2L)

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