Example project: Performance Analytics accelerator
To complement this documentation, we offer a sample NLG Studio project created by Arria's developers. You can download the Performance Analytics accelerator project from here.
The Performance Analytics project generates a sales report that covers sales for the current year, year-on-year sales, and trends analysis. The narrative this project generates drills down to discuss the sales drivers and offsets by region and by product.
The project creates two different types of narratives:
one based on standard deviation
another based on performance threshold
The project also includes user-defined functions that handle:
aggregation of data
business rules
ordering
number formatting
There is built-in logic for analysis in a number of analytics-focused scripts, such as:
analyzing level-two and level-three entries and finding drivers and offsets
analyzing level-two year-on-year data and finding drivers and offsets
finding the difference between actual and target sales
determining weight distribution
returning results of analysis of an object
You can use this project as both a learning tool, and a project to build on or customize for your own use.