most_correlated: Most Correlated

View source: R/multi-id-functions.R

most_correlatedR Documentation

Most Correlated

Description

In a table with multiple asset IDs, reports the asset ID most correlated to the subject asset_Id ID.

Usage

most_correlated(metric_df, subject, template_id = NULL)

Arguments

metric_df

A dataframe with the following columns: asset_id (chr), value (dbl), time (date or dttm)

subject

The asset ID to measure correlations for.

template_id

Optional. The template to be used for the article.

Value

A sentence denoting the asset ID most correlated to the declared subject.

Examples

## Not run: 
most_correlated(metric_df)

## End(Not run)


jupitertrades/tabletotext documentation built on Oct. 31, 2022, 5:47 p.m.