update_cluster_match: Update the match cluster of a CoRecMotif

View source: R/utils.R

update_cluster_matchR Documentation

Update the match cluster of a CoRecMotif

Description

Updates the match_cluster slot of a CoRecMotif based on the provided cluster assignments and the name of the motif in the CoRecMotif's match_motif slot.

Usage

update_cluster_match(
  corecmotif,
  cluster_assignments = NULL,
  check_corecmotif = TRUE
)

Arguments

corecmotif

CoRecMotif. The CoRecMotif to update.

cluster_assignments

data.frame or NULL. A table mapping the reference motifs to motif clusters or NULL to reset the match_cluster slot to NA. See motif_clusters for expected columns. (Default: NULL)

check_corecmotif

logical(1). Should corecmotif be checked for validity? Setting this to FALSE can increase speed, but if corecmotif is not a valid CoRecMotif, it may produce uninformative error messages. (Default: TRUE)

Value

A CoRecMotif with its match_cluster slot updated.

Examples

print("FILL THIS IN")

Siggers-Lab/hTF_array documentation built on Feb. 7, 2024, 11:25 p.m.