Function reference • narrator

Narratives

Functions to create text out of data

narrate_descriptive(): Create Descriptive Text Narratives from Data

narrate_forecast(): Create Narrative for Time Series Forecast Data Frames

narrate_trend(): Create Narrative for Metric Development in Time

enhance_narrative(): Enhance the narrative output with ChatGPT

translate_narrative(): Translate the narrative output with ChatGPT

summarize_narrative(): Summarize the narrative output with ChatGPT

list_templates(): Return a Table of all Templates Currently Available in the Package

Formatting Helpers

Helper functions to change the output of the narratives

add_tag(): Add HTML Tags to Text

clean_tags(): Clean HTML Tags from the Text

clean_text(): Clean Text String

format_num(): Format Numeric Values

format_pct(): Add HTML Tags with Colors to Percentage Values in Text

format_text(): Add HTML Tags to Add Color and Boldness

to_html(): Format the Narrative with HTML tags for Interactive Reports and Applications

Helpers

Helpers for other than formatting purposes

get_frequency(): Get Date Frequency of the Data

edit_templates(): Interactively Edit Package Templates

Pluralization

Helper functions pluralize/singularize words in English

pluralize(): Pluralize a Word in English

singularize(): Singularize a Word in English

is_plural() is_singular(): Test Plural State of an English Word

Shiny Module

Module for use of narrator in shiny

narratorUI(): Shiny Module for Narrator

narratorServer(): Server Logic for Narrator

Data

Embedded Data

sales: Synthetic Sales Data