report_highest_performer: Report Highest Performer

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

report_highest_performerR Documentation

Report Highest Performer

Description

In a table with multiple asset IDs, reports the asset ID (subject) with the highest value.

Usage

report_highest_performer(metric_df, template_id = NULL)

Arguments

metric_df

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

template_id

Optional. The template to be used for the article.

Value

A sentence denoting the highest performer out of a set of given asset IDs.

Examples

## Not run: 
report_highest_performer(metric_df)

## End(Not run)


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