rLDCP (version 1.0.2)

report_template: Define the report template

Description

The text generation algorithm contains the programming code capable of generating the appropriate report to each specific user. Algorithms must select and order the linguistic expressions to generate the text included in the report. #' The report_template constructor receive as arguments the list of properties and the method (programming code) capable of generating the appropriate report.

Usage

report_template(properties = NULL, method, description = NULL)

Arguments

properties

may be a vector, list or matrix with the user's needs, preferences and goals. By default properties = NULL.

method

is the function that generates the appropriate report. The method must have two arguments: the list of properties and the list of pms: my_report_method <- function(properties, pm){...}.

description

is the result of call the report template. By default is NULL

Value

The generated report_template= list(properties, method,description)

Examples

# NOT RUN {
properties = NULL
report_method <- function(properties,pm){
  pm_report(pm$pm_frame)
}
my_report <- report_template(properties,
                    report_method)
# }