Write a curriculum mapping report

Renders a CurriculumMapping as a self-contained HTML document: objective quality, alignment, cognitive level, assessment, what to act on, and how the run was produced, with a contents down the left to move between them. The assessment section says it was not run, rather than being omitted, when a course supplied none – an absent check and a passed check must not look alike.

Usage

report_curriculum(x, file = NULL, title = NULL)

Arguments

x

CurriculumMapping object, from map_curriculum().

file

Character: Path to write to. NULL, the default, returns the HTML as a character scalar instead of writing it.

title

Character: Document title. Defaults to the course name and term.

Value

The path written, invisibly; or the HTML, if file = NULL.

Details

Nothing here asks a model anything. Every number is already in the object, so the same run always renders the same document and any finding can be traced to the table it came from – which is what makes it safe to hand to someone who will act on it.

The document needs no server, no widget runtime and no pandoc: it is one file that opens in a browser and survives being emailed. The alignment matrix is rendered as a shaded table for the same reason. For a presentation, the Sankey from as_sankey() and rtemis.draw::draw_sankey() remains the better picture.

Author

EDG

Examples

if (FALSE) { # \dontrun{
  report_curriculum(cm, "datasci213_report.html")
} # }