Helper function to compute metrics.

sim_metrics_helper helps compute metrics by aggregating and scaling.

sim_metrics_helper(
  collated_sim,
  sim_type_signal,
  sim_type_background,
  summary_cols,
  annotation_cols,
  identifier = NULL,
  use_furrr = FALSE
)

Arguments

collated_sim

output of sim_collated, which is a data.frame with some attributes.

sim_type_signal

character string specifying the type of replication being measured. This must be one of the strings "rep" or "rep_group".

sim_type_background

character string specifying the background distributions for computing scaled metrics. This must be one of the strings "non_rep" or "ref".

summary_cols

character list specifying columns by which to group similarities.

annotation_cols

character list specifying annotation columns.

identifier

character string specifying the identifier to add as a suffix to the columns containing scaled-aggregated metrics.

use_furrr

boolean indicating whether to use the furrr library for parallel processing.

Value

data.frame of metrics.