annotate_cluster: Annotate a single cluster

View source: R/annotation_functions.R

annotate_clusterR Documentation

Annotate a single cluster

Description

Annotate a single cluster

Usage

annotate_cluster(
  identifying_data,
  cluster_id,
  couple_ids = NULL,
  compound_levels = NULL,
  biosoc_levels = NULL,
  score_only = FALSE,
  other_peaks_warning = FALSE
)

Arguments

identifying_data

A data.frame containing possible identifications.

cluster_id

A string indicating the cluster id.

couple_ids

A 2-tuple indicating specific compounds to consider for annotation

compound_levels

A vector containing the compound levels to consider, in the given order.

biosoc_levels

A vector containing the biosource levels to consider, in the given order.

score_only

Whether to find the most probable annotation on scores only (without using the biosoc_levels and compound_levels)

other_peaks_warning

Whether to issue a warning if other possible annotated peaks exists in the cluster

Value

A data.frame with the selected identification annotated.


eMetaboHUB/MS-CleanR documentation built on Jan. 3, 2024, 8:55 p.m.