hc_summarise_metrics: Summarise metrics

Description Usage Arguments Value Examples

View source: R/reporting.R

Description

Calculate mean and sd for specified metrics and return formatted results.

Usage

1
2
3
hc_summarise_metrics(df, group_cols = c("Group.Id", "Type", "Filter"),
  metric_cols = c("METRIC.F1_Score", "METRIC.Recall", "METRIC.Precision",
  "METRIC.Frac_NA"), digits = 4)

Arguments

df

A data.frame object.

group_cols

Vector of columns to group counts by. Observations within the same group will be treated as replicates.

metric_cols

Vector of metric columns for which to calculate summary stats.

digits

Number of decimal places. Default: 4.

Value

A formatted data.frame object.

Examples

1
2
3
4
5
## Not run: 
df <- extract_metrics(happy_compare, table = "summary")
hc_summarise_metrics(df)

## End(Not run)

Illumina/happyCompare documentation built on July 12, 2019, 7:57 p.m.