sim_metrics_signif: Report p-values for metrics

In matric: Metrics for Similarity Matrices

Report p-values for metrics

Description

Report p-values for metrics

Usage

sim_metrics_signif(
  metrics,
  background_type,
  level_identifier,
  metric_name,
  ...
)

Arguments

metrics	Metrics data frame, containing at least two columns "sim_stat_signal_n_{background_type}_{level_identifier}" and "sim_stat_background_n_{background_type}_{level_identifier}".
background_type	Background type. Either "ref" or "non_rep".
level_identifier	Level identifier. Either "i" (Level 1_0) or "g" (Level 2_1).
metric_name	name of metric. Only "average_precision" is currently implemented.
...	arguments passed downstream.

Value

Metrics data frame containing two extra columns: the -log10 p-value and q-value of the specified metric "sim_retrieval_average_precision_{background_type}_{level_identifier}_nlog10pvalue"

matric documentation built on April 1, 2023, 12:19 a.m.