Skip to content

Overview of the HTML reporting package

The reporting package, +rephrase, uses HTML/CSS/Javascript to build interactive reports consisting of charts, tables, snippets of code, text, structured in sections or pages.

Structure of reports

The rephrase.Report is the top-level container for all report elements. The rephrase.Report may include the following:

Containers:

  • rephrase.Section
  • rephrase.Grid
  • rephrase.Pager
  • rephrase.SeriesChart
  • rephrase.CurveChart
  • rephrase.Table

Terminal elements:

  • rephrase.Matrix
  • rephrase.Text
  • rephrase.Pagebreak

The rephrase.Section is a report structuring object, dividing it into logical parts referred to in the Table of Contents. The rephrase.Section may include the following:

Containers:

  • rephrase.Section
  • rephrase.Grid
  • rephrase.Pager
  • rephrase.SeriesChart
  • rephrase.CurveChart
  • rephrase.Table

Terminal elements:

  • rephrase.Matrix
  • rephrase.Text
  • rephrase.Pagebreak

The rephrase.Grid is a container laying out the elements in an N-by-M grid. The rephrase.Grid may include the following:

Containers:

  • rephrase.SeriesChart
  • rephrase.CurveChart
  • rephrase.Table

Terminal elements:

  • rephrase.Matrix

The rephrase.Pager creates an interactive switch with multiple pages. The rephrase.Pager may include the following:

Containers:

  • rephrase.Section
  • rephrase.Grid
  • rephrase.Pager
  • rephrase.SeriesChart
  • rephrase.CurveChart
  • rephrase.Table

Terminal elements:

  • rephrase.Matrix
  • rephrase.Text

The rephrase.SeriesChart is a time series chart, possibly with multiple series included. The rephrase.SeriesChart may include the following:

Terminal elements:

  • rephrase.Series

The rephrase.CurveChart is a term structure chart designed to show yiled curves and other data along a term-to-maturity dimension. The rephrase.CurveChart may include the following:

Terminal elements:

  • rephrase.Curve

The rephrase.Table is a time series table. The rephrase.Table may include the following:

Terminal elements:

  • rephrase.DiffSeries
  • rephrase.Heading
  • rephrase.Series

Categorical list of objects

Constructing new reports

Function Description
rephrase.Report Create a Report object for rephrase reports

Structuring the report

Function Description
rephrase.Grid Create a Grids object for rephrase reports
rephrase.Pagebreak Create a Pagebreak object for rephrase reports
rephrase.Pager Create a Text object for rephrase reports
rephrase.Section Create a Section object for rephrase reports

Creating time series charts

Function Description
rephrase.SeriesChart Create a SeriesChart object for rephrase reports
rephrase.Series Create a Series object for rephrase reports
rephrase.Bands Create a Bands object for rephrase reports
rephrase.Highlight Create a Highlight object for rephrase reports

Creating term structure charts

Function Description
rephrase.CurveChart Create a CurveChart object for rephrase reports
rephrase.Curve Create a Curve object for rephrase reports
rephrase.Highlight Create a Highlight object for rephrase reports

Creating time series tables

Function Description
rephrase.Table Create a Table object for rephrase reports
rephrase.Series Create a Series object for rephrase reports
rephrase.DiffSeries Create a DiffSeries object for rephrase reports

Creating data matrices

Function Description
rephrase.Matrix Create a Matrix object for rephrase reports

Creating text elements

Function Description
rephrase.Text Create a Text object for rephrase reports