calculate_metrics: Calculate the similarity between two trajectory models.

Description Usage Arguments Details

View source: R/calculate_metrics.R

Description

One use case for these metrics is to calculate the accuracy of a certain prediction compared to a reference trajectory. However, these metrics can also be used for other purposes, such as clustering of trajectories.

Usage

1
2
calculate_metrics(dataset, model, metrics = dyneval::metrics$metric_id,
  expression_source = dataset$expression)

Arguments

dataset

The first trajectory, in most cases a gold standard trajectory

model

The second trajectory, in most cases a predicted trajectory

metrics

Which metrics to evaluate. Check dyneval::metrics for a list of possible metrics. Passing a custom metric function with format function(dataset, model) { 1 } is also supported. The name of this function within the list will be used as the name of the metric.

expression_source

The expression data matrix, with features as columns.

  • If a matrix is provided, it is used as is.

  • If a character is provided, dataset[[expression_source]] should contain the matrix.

  • If a function is provided, that function will be called in order to obtain the expression (useful for lazy loading).

Details

Some metrics are asymmetric (see dyneval::metrics$symmetric), in which case the order of the dataset and model parameters matters.


dynverse/dyneval documentation built on May 25, 2019, 4:25 p.m.