stepan
/
dynare
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed indentation in section 7.

time-shift
Stéphane Adjemia (Scylla) 2019-02-04 12:48:27 +01:00
parent b61c16a003
commit 5a4b957267
Signed by untrusted user who does not match committer: stepan
GPG Key ID: A6D44CB9C64CE77B
1 changed files with 840 additions and 618 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

434
src/source/reporting.rst
View File

@ -1,35 +1,77 @@
.. default-domain:: dynare
.. |br| raw:: html
<br>
.. highlight:: matlab
#########
Reporting
#########
Dynare provides a simple interface for creating LaTeX reports, comprised of LaTeX tables and ``PGFPLOTS/TikZ graphs``. You can use the report as created through Dynare or pick out the pieces (tables and graphs) you want for inclusion in your own paper. Though Dynare provides a subset of options available through ``PGFPLOTS/TikZ``, you can easily modify the graphs created by Dynare using the options available in the ``PGFPLOTS/TikZ`` manual. You can either do this manually or by passing the options to :opt:`miscTikzAxisOptions <miscTikzAxisOptions, STRING>` or :opt:`graphMiscTikzAddPlotOptions <graphMiscTikzAddPlotOptions, STRING>`.
Dynare provides a simple interface for creating LaTeX reports,
comprised of LaTeX tables and ``PGFPLOTS/TikZ graphs``. You can use
the report as created through Dynare or pick out the pieces (tables
and graphs) you want for inclusion in your own paper. Though Dynare
provides a subset of options available through ``PGFPLOTS/TikZ``, you
can easily modify the graphs created by Dynare using the options
available in the ``PGFPLOTS/TikZ`` manual. You can either do this
manually or by passing the options to :opt:`miscTikzAxisOptions
<miscTikzAxisOptions, STRING>` or :opt:`graphMiscTikzAddPlotOptions
<graphMiscTikzAddPlotOptions, STRING>`.
Reports are created and modified by calling methods on class objects. The objects are hierarchical, with the following order (from highest to lowest): ``Report``, ``Page``, ``Section``, ``Graph/Table/Vspace``, ``Series``. For simplicity of syntax, we abstract away from these classes, allowing you to operate directly on a ``Report`` object, while maintaining the names of these classes in the ``Report`` Class methods you will use.
Reports are created and modified by calling methods on class
objects. The objects are hierarchical, with the following order (from
highest to lowest): ``Report``, ``Page``, ``Section``,
``Graph/Table/Vspace``, ``Series``. For simplicity of syntax, we
abstract away from these classes, allowing you to operate directly on
a ``Report`` object, while maintaining the names of these classes in
the ``Report`` Class methods you will use.
The report is created sequentially, command by command, hence the order of the commands matters. When an object of a certain hierarchy is inserted, all methods will function on that object until an object of equal or greater hierarchy is added. Hence, once you add a ``Page`` to the report, every time you add a ``Section`` object, it will be added to this ``Page`` until another ``Page`` is added to the report (via :repmeth:`addPage`). This will become more clear with the example at the end of the section.
The report is created sequentially, command by command, hence the
order of the commands matters. When an object of a certain hierarchy
is inserted, all methods will function on that object until an object
of equal or greater hierarchy is added. Hence, once you add a ``Page``
to the report, every time you add a ``Section`` object, it will be
added to this ``Page`` until another ``Page`` is added to the report
(via :repmeth:`addPage`). This will become more clear with the example
at the end of the section.
**Options to the methods are passed differently than those to Dynare commands**. They take the form of named options to Matlab functions where the arguments come in pairs (e.g. ``function_name(`option_1_name', `option_1_value', `option_2_name', `option_2_value',`` ...), where ``option_X_name`` is the name of the option while ``option_X_value`` is the value assigned to that option). The ordering of the option pairs matters only in the unusual case when an option is provided twice (probably erroneously). In this case, the last value passed is the one that is used.
Options to the methods are passed differently than those to Dynare
commands. They take the form of named options to Matlab functions
where the arguments come in pairs
(e.g. ``function_name(`option_1_name', `option_1_value',
`option_2_name', `option_2_value', ...)``, where ``option_X_name`` is
the name of the option while ``option_X_value`` is the value assigned
to that option). The ordering of the option pairs matters only in the
unusual case when an option is provided twice (probably
erroneously). In this case, the last value passed is the one that is
used.
Below, you will see a list of methods available for the Report class and a clarifying example.
Below, you will see a list of methods available for the Report class
and a clarifying example.
.. repmethod:: report
.. construct:: report
Instantiates a ``Report`` object.
|br| Instantiates a ``Report`` object.
*Options*
.. option:: compiler, FILENAME
The full path to the LaTeX compiler on your system. If this option is not provided, Dynare will try to find the appropriate program to compile LaTeX on your system. Default is system dependent:
The full path to the LaTeX compiler on your system. If this
option is not provided, Dynare will try to find the
appropriate program to compile LaTeX on your system. Default
is system dependent:
* Windows: the result of findtexmf ```--file-type=exe pdflatex``.
* Windows: the result of findtexmf ``--file-type=exe pdflatex``.
* macOS and Linux: the result of ``which pdflatex``.
.. option:: showDate, BOOLEAN
Display the date and time when the report was compiled. Default: ``true``.
Display the date and time when the report was
compiled. Default: ``true``.
.. option:: fileName, FILENAME
@ -37,7 +79,8 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: header, STRING
The valid LaTeX code to be included in the report before ``\begin{document}``. Default: ``empty``.
The valid LaTeX code to be included in the report before
``\begin{document}``. Default: ``empty``.
.. option:: margin, DOUBLE
@ -57,16 +100,19 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: showOutput, BOOLEAN
Print report creation progress to screen. Shows you the page number as it is created and as it is written. This is useful to see where a potential error occurs in report creation. Default: ``true``.
Print report creation progress to screen. Shows you the page
number as it is created and as it is written. This is useful
to see where a potential error occurs in report
creation. Default: ``true``.
.. option:: title, STRING
Report Title. Default: ``none``.
.. repmethod:: addPage
.. reportingmethod:: addPage
Adds a Page to the Report.
|br| Adds a Page to the Report.
*Options*
@ -76,7 +122,12 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: latex, STRING
The valid LaTeX code to be used for this page. Alows the user to create a page to be included in the report by passing LaTeX code directly. If this option is passed, the page itself will be saved in the :opt:`pageDirName <pageDirName, STRING>` directory in the form ``page_X.tex`` where X refers to the page number. Default: ``empty``.
The valid LaTeX code to be used for this page. Alows the user
to create a page to be included in the report by passing LaTeX
code directly. If this option is passed, the page itself will
be saved in the :opt:`pageDirName <pageDirName, STRING>`
directory in the form ``page_X.tex`` where X refers to the
page number. Default: ``empty``.
.. option:: orientation, `landscape' | `portrait'
@ -84,7 +135,9 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: pageDirName, STRING
The name of the folder in which to store this page. Only used when the :opt:`latex <latex, STRING>` command is passed. Default: ``tmpRepDir``.
The name of the folder in which to store this page. Only used
when the :opt:`latex <latex, STRING>` command is
passed. Default: ``tmpRepDir``.
.. option:: paper, `a4' | `letter'
@ -92,20 +145,30 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: title, STRING | CELL_ARRAY_STRINGS
With one entry (a STRING), the title of the page. With more than one entry (a CELL_ARRAY_STRINGS), the title and subtitle(s) of the page. Values passed must be valid LaTeX code (e.g., ``%`` must be ``\%``). Default: ``none``.
With one entry (a STRING), the title of the page. With more
than one entry (a CELL_ARRAY_STRINGS), the title and
subtitle(s) of the page. Values passed must be valid LaTeX
code (e.g., ``%`` must be ``\%``). Default: ``none``.
.. option:: titleFormat, STRING | CELL_ARRAY_STRINGS
A string representing the valid LaTeX markup to use on ``title``. The number of cell array entries must be equal to that of the ``title`` option if you do not want to use the default value for the title (and subtitles). Default: ``\large\bfseries``.
A string representing the valid LaTeX markup to use on
``title``. The number of cell array entries must be equal to
that of the ``title`` option if you do not want to use the
default value for the title (and subtitles). Default:
``\large\bfseries``.
.. option:: titleTruncate, INTEGER
Useful when automatically generating page titles that may become too long, ``titleTruncate`` can be used to truncate a title (and subsequent subtitles) when they pass the specified number of characters. Default: ``.off``.
Useful when automatically generating page titles that may
become too long, ``titleTruncate`` can be used to truncate a
title (and subsequent subtitles) when they pass the specified
number of characters. Default: ``.off``.
.. repmethod:: addSection
.. reportingmethod:: addSection
Adds a ``Section`` to a ``Page``.
|br| Adds a ``Section`` to a ``Page``.
*Options*
@ -115,12 +178,13 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: height, STRING
A string to be used with the ``\sectionheight`` LaTeX command. Default: ``'!'``
A string to be used with the ``\sectionheight`` LaTeX
command. Default: ``'!'``
.. repmethod:: addGraph
.. reportingmethod:: addGraph
Adds a ``Graph`` to a ``Section``.
|br| Adds a ``Graph`` to a ``Section``.
*Options*
@ -130,15 +194,20 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: axisShape, `box' | `L'
The shape the axis should have. ```box'`` means that there is an axis line to the left, right, bottom, and top of the graphed line(s). 'L'`` means that there is an axis to the left and bottom of the graphed line(s). Default: ```box'``.
The shape the axis should have. ```box'`` means that there is
an axis line to the left, right, bottom, and top of the
graphed line(s). 'L'`` means that there is an axis to the left
and bottom of the graphed line(s). Default: ```box'``.
.. option:: graphDirName, STRING
The name of the folder in which to store this figure. Default: ``tmpRepDir``.
The name of the folder in which to store this figure. Default:
``tmpRepDir``.
.. option:: graphName, STRING
The name to use when saving this figure. Default: something of the form ``graph_pg1_sec2_row1_col3.tex``.
The name to use when saving this figure. Default: something of
the form ``graph_pg1_sec2_row1_col3.tex``.
.. option:: height, DOUBLE
@ -146,17 +215,24 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: showGrid, BOOLEAN
Whether or not to display the major grid on the graph. Default: ``true``.
Whether or not to display the major grid on the
graph. Default: ``true``.
.. option:: showLegend, BOOLEAN
Whether or not to display the legend.
NB: Unless you use the :opt:`graphLegendName <graphLegendName, STRING>` option, the name displayed in the legend is the tex name associated with the ``dseries``. You can modify this tex name by using :dsermeth:`tex_rename <B = tex_rename>`. Default: ``false``.
Unless you use the :opt:`graphLegendName <graphLegendName,
STRING>` option, the name displayed in the legend is the tex
name associated with the ``dseries``. You can modify this tex
name by using :dsermeth:`tex_rename <B =
tex_rename>`. Default: ``false``.
.. option:: legendAt, NUMERICAL_VECTOR
The coordinates for the legend location. If this option is passed, it overrides the :opt:`legendLocation <legendLocation, OPTION>` option. Must be of size ``2``. Default: ``empty``.
The coordinates for the legend location. If this option is
passed, it overrides the :opt:`legendLocation <legendLocation,
OPTION>` option. Must be of size ``2``. Default: ``empty``.
.. option:: showLegendBox, BOOLEAN
@ -185,29 +261,52 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: miscTikzAxisOptions, STRING
If you are comfortable with ``PGFPLOTS/TikZ``, you can use this option to pass arguments directly to the ``PGFPLOTS/TikZ`` axis environment command. Specifically to be used for desired ``PGFPLOTS/TikZ`` options that have not been incorporated into Dynare Reporting. Default: ``empty``.
If you are comfortable with ``PGFPLOTS/TikZ``, you can use
this option to pass arguments directly to the
``PGFPLOTS/TikZ`` axis environment command. Specifically to be
used for desired ``PGFPLOTS/TikZ`` options that have not been
incorporated into Dynare Reporting. Default: ``empty``.
.. option:: miscTikzPictureOptions, STRING
If you are comfortable with ``PGFPLOTS/TikZ``, you can use this option to pass arguments directly to the ``PGFPLOTS/TikZ`` ``tikzpicture`` environment command. (e.g., to scale the graph in the x and y dimensions, you can pass following to this option: 'xscale=2.5, yscale=0.5'``). Specifically to be used for desired ``PGFPLOTS/TikZ`` options that have not been incorporated into Dynare Reporting. Default: ``empty``.
If you are comfortable with ``PGFPLOTS/TikZ``, you can use
this option to pass arguments directly to the
``PGFPLOTS/TikZ`` ``tikzpicture`` environment command. (e.g.,
to scale the graph in the x and y dimensions, you can pass
following to this option: 'xscale=2.5,
yscale=0.5'``). Specifically to be used for desired
``PGFPLOTS/TikZ`` options that have not been incorporated into
Dynare Reporting. Default: ``empty``.
.. option:: seriesToUse, CELL_ARRAY_STRINGS
The names of the series contained in the ``dseries`` provided to the :opt:`data <data, dseries>` option. If empty, use all series provided to ``data`` option. Default: ``empty``.
The names of the series contained in the ``dseries`` provided
to the :opt:`data <data, dseries>` option. If empty, use all
series provided to ``data`` option. Default: ``empty``.
.. option:: shade, dates
The date range showing the portion of the graph that should be shaded. Default: ``none``.
The date range showing the portion of the graph that should be
shaded. Default: ``none``.
.. option:: shadeColor, STRING
The color to use in the shaded portion of the graph. All valid color strings defined for use by ``PGFPLOTS/TikZ`` are valid. A list of defined colors is::
The color to use in the shaded portion of the graph. All valid
color strings defined for use by ``PGFPLOTS/TikZ`` are
valid. A list of defined colors is::
'red', 'green', 'blue', 'cyan', 'magenta', 'yellow', 'black', 'gray',
'white','darkgray', 'lightgray', 'brown', 'lime', 'olive', 'orange',
'pink', 'purple', 'teal', 'violet'.
Furthermore, You can use combinations of these colors. For example, if you wanted a color that is 20\% green and 80\% purple, you could pass the string ``'green!20!purple'``. You can also use RGB colors, following the syntax: ```rgb,255:red,231;green,84;blue,121'`` which corresponds to the RGB color ``(231;84;121)``. More examples are available in the section 4.7.5 of the ``PGFPLOTS/TikZ`` manual, revision 1.10. Default: ```green'``
Furthermore, You can use combinations of these colors. For
example, if you wanted a color that is 20\% green and 80\%
purple, you could pass the string ``'green!20!purple'``. You
can also use RGB colors, following the syntax:
```rgb,255:red,231;green,84;blue,121'`` which corresponds to
the RGB color ``(231;84;121)``. More examples are available in
the section 4.7.5 of the ``PGFPLOTS/TikZ`` manual, revision
1.10. Default: ```green'``
.. option:: shadeOpacity, DOUBLE
@ -215,7 +314,8 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: tickFontSize, OPTION
The font size for x- and y-axis tick labels. Possible values for OPTION are::
The font size for x- and y-axis tick labels. Possible values
for OPTION are::
`tiny' | `scriptsize' | `footnotesize' | `small' | `normalsize' |
`large' | `Large' | `LARGE' | `huge' | `Huge'
@ -224,7 +324,8 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: title, STRING | CELL_ARRAY_STRINGS
Same as :opt:`title <title, STRING | CELL_ARRAY_STRINGS>`, just for graphs.
Same as :opt:`title <title, STRING | CELL_ARRAY_STRINGS>`,
just for graphs.
.. option:: titleFontSize, OPTION
@ -237,7 +338,10 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: titleFormat, STRING
The format to use for the graph title. Unlike :opt:`titleFormat <titleFormat, STRING | CELL_ARRAY_STRINGS>`, due to a constraint of ``TikZ``, this format applies to the title and subtitles. Default: ``TikZ`` default.
The format to use for the graph title. Unlike
:opt:`titleFormat <titleFormat, STRING | CELL_ARRAY_STRINGS>`,
due to a constraint of ``TikZ``, this format applies to the
title and subtitles. Default: ``TikZ`` default.
.. option:: width, DOUBLE
@ -245,7 +349,11 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: writeCSV, BOOLEAN
Whether or not to write a CSV file with only the plotted data. The file will be saved in the directory specified by :opt:`graphDirName <graphDirName, STRING>` with the same base name as specified by :opt:`graphName <graphName, STRING>` with the ending ``.csv``. Default: ``false``.
Whether or not to write a CSV file with only the plotted
data. The file will be saved in the directory specified by
:opt:`graphDirName <graphDirName, STRING>` with the same base
name as specified by :opt:`graphName <graphName, STRING>` with
the ending ``.csv``. Default: ``false``.
.. option:: xlabel, STRING
@ -257,7 +365,8 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: xAxisTight, BOOLEAN
Use a tight x axis. If false, uses ``PGFPLOTS/TikZ`` ``enlarge x limits`` to choose appropriate axis size. Default: ``true``.
Use a tight x axis. If false, uses ``PGFPLOTS/TikZ`` ``enlarge
x limits`` to choose appropriate axis size. Default: ``true``.
.. option:: xrange, dates
@ -265,11 +374,20 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: xTicks, NUMERICAL_VECTOR
Used only in conjunction with :opt:`xTickLabels <xTickLabels, CELL_ARRAY_STRINGS | `ALL'>`, this option denotes the numerical position of the label along the x-axis. The positions begin at ``1``. Default: the indices associated with the first and last dates of the ``dseries`` and, if passed, the index associated with the first date of the :opt:`shade <shade, dates>` option.
Used only in conjunction with :opt:`xTickLabels <xTickLabels,
CELL_ARRAY_STRINGS | `ALL'>`, this option denotes the
numerical position of the label along the x-axis. The
positions begin at ``1``. Default: the indices associated with
the first and last dates of the ``dseries`` and, if passed,
the index associated with the first date of the :opt:`shade
<shade, dates>` option.
.. option:: xTickLabels, CELL_ARRAY_STRINGS | `ALL'
The labels to be mapped to the ticks provided by ``xTicks``. Default: the first and last dates of the ``dseries`` and, if passed, the date first date of the :opt:`shade <shade, dates>` option.
The labels to be mapped to the ticks provided by
``xTicks``. Default: the first and last dates of the
``dseries`` and, if passed, the date first date of the
:opt:`shade <shade, dates>` option.
.. option:: xTickLabelAnchor, STRING
@ -281,15 +399,20 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: yAxisTight, BOOLEAN
Use a tight y axis. If false, uses ``PGFPLOTS/TikZ`` ``enlarge y limits`` to choose appropriate axis size. Default: ``false``.
Use a tight y axis. If false, uses ``PGFPLOTS/TikZ`` ``enlarge
y limits`` to choose appropriate axis size. Default:
``false``.
.. option:: yrange, NUMERICAL_VECTOR
The boundary on the y-axis to display in the graph, represented as a ``NUMERICAL_VECTOR`` of size ``2``, with the first entry less than the second entry. Default: ``all``.
The boundary on the y-axis to display in the graph,
represented as a ``NUMERICAL_VECTOR`` of size ``2``, with the
first entry less than the second entry. Default: ``all``.
.. option:: yTickLabelFixed, BOOLEAN
Round the y tick labels to a fixed number of decimal places, given by ``yTickLabelPrecision``. Default: ``.true``.
Round the y tick labels to a fixed number of decimal places,
given by ``yTickLabelPrecision``. Default: ``.true``.
.. option:: yTickLabelPrecision, INTEGER
@ -297,11 +420,13 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: yTickLabelScaled, BOOLEAN
Determines whether or not there is a common scaling factor for the y axis. Default: ``true``.
Determines whether or not there is a common scaling factor for
the y axis. Default: ``true``.
.. option:: yTickLabelZeroFill, BOOLEAN
Whether or not to fill missing precision spots with zeros. Default: ``true``.
Whether or not to fill missing precision spots with
zeros. Default: ``true``.
.. option:: showZeroline, BOOLEAN
@ -309,12 +434,15 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: zeroLineColor, STRING
The color to use for the zero line. Only used if :opt:`showZeroLine <showZeroline, BOOLEAN>` is true. See the explanation in :opt:`shadeColor <shadeColor, STRING>` for how to use colors with reports. Default: ```black'``.
The color to use for the zero line. Only used if
:opt:`showZeroLine <showZeroline, BOOLEAN>` is true. See the
explanation in :opt:`shadeColor <shadeColor, STRING>` for how
to use colors with reports. Default: ```black'``.
.. repmethod:: addTable
.. reportingmethod:: addTable
Adds a ``Table`` to a ``Section``.
|br| Adds a ``Table`` to a ``Section``.
*Options*
@ -324,15 +452,22 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: highlightRows, CELL_ARRAY_STRINGS
A cell array containing the colors to use for row highlighting. See :opt:`shadeColor <shadeColor, STRING>` for how to use colors with reports. Highlighting for a specific row can be overridden by using the :opt:`tableRowColor <tableRowColor, STRING>` option to :repmeth:`addSeries`. Default: ``empty``.
A cell array containing the colors to use for row
highlighting. See :opt:`shadeColor <shadeColor, STRING>` for
how to use colors with reports. Highlighting for a specific
row can be overridden by using the :opt:`tableRowColor
<tableRowColor, STRING>` option to
:repmeth:`addSeries`. Default: ``empty``.
.. option:: showHlines, BOOLEAN
Whether or not to show horizontal lines separating the rows. Default: ``false``.
Whether or not to show horizontal lines separating the
rows. Default: ``false``.
.. option:: precision, INTEGER
The number of decimal places to report in the table data. Default: ``1``.
The number of decimal places to report in the table
data. Default: ``1``.
.. option:: range, dates
@ -344,11 +479,13 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: tableDirName, STRING
The name of the folder in which to store this table. Default: ``tmpRepDir``.
The name of the folder in which to store this table. Default:
``tmpRepDir``.
.. option:: tableName, STRING
The name to use when saving this table. Default: something of the form ``table_pg1_sec2_row1_col3.tex``.
The name to use when saving this table. Default: something of
the form ``table_pg1_sec2_row1_col3.tex``.
.. option:: title, STRING
@ -356,30 +493,41 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: titleFormat, STRING
Same as :opt:`titleFormat <titleFormat, STRING | CELL_ARRAY_STRINGS>`, just for tables. Default: ``\large``.
Same as :opt:`titleFormat <titleFormat, STRING |
CELL_ARRAY_STRINGS>`, just for tables. Default: ``\large``.
.. option:: vlineAfter, dates | CELL_ARRAY_DATES
Show a vertical line after the specified date (or dates if a cell array of dates is passed). Default: ``empty``.
Show a vertical line after the specified date (or dates if a
cell array of dates is passed). Default: ``empty``.
.. option:: vlineAfterEndOfPeriod, BOOLEAN
Show a vertical line after the end of every period (i.e. after every year, after the fourth quarter, etc.). Default: ``false``.
Show a vertical line after the end of every period (i.e. after
every year, after the fourth quarter, etc.). Default:
``false``.
.. option:: showVlines, BOOLEAN
Whether or not to show vertical lines separating the columns. Default: ``false``.
Whether or not to show vertical lines separating the
columns. Default: ``false``.
.. option:: writeCSV, BOOLEAN
Whether or not to write a CSV file containing the data displayed in the table. The file will be saved in the directory specified by :opt:`tableDirName <tableDirName, STRING>` with the same base name as specified by :opt:`tableName <tableName, STRING>` with the ending ``.csv``. Default: ``false``.
Whether or not to write a CSV file containing the data
displayed in the table. The file will be saved in the
directory specified by :opt:`tableDirName <tableDirName,
STRING>` with the same base name as specified by
:opt:`tableName <tableName, STRING>` with the ending
``.csv``. Default: ``false``.
.. repmethod:: addSeries
.. reportingmethod:: addSeries
Adds a ``Series`` to a ``Graph`` or a ``Table``.
|br| Adds a ``Series`` to a ``Graph`` or a ``Table``.
NB: Options specific to graphs begin with ```graph'`` while options specific to tables begin with ```table'``.
Options specific to graphs begin with ```graph'`` while options
specific to tables begin with ```table'``.
*Options*
@ -389,39 +537,56 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: graphBar, BOOLEAN
Whether or not to display this series as a bar graph as oppsed to the default of displaying it as a line graph. Default: ``false``.
Whether or not to display this series as a bar graph as oppsed
to the default of displaying it as a line graph. Default:
``false``.
.. option:: graphFanShadeColor, STRING
The shading color to use between a series and the previously-added series in a graph. Useful for making fan charts. Default: ``empty``.
The shading color to use between a series and the
previously-added series in a graph. Useful for making fan
charts. Default: ``empty``.
.. option:: graphFanShadeOpacity, INTEGER
The opacity of the color passed in :opt:`graphFanShadeColor <graphFanShadeColor, STRING>`. Default: ``50``.
The opacity of the color passed in :opt:`graphFanShadeColor
<graphFanShadeColor, STRING>`. Default: ``50``.
.. option:: graphBarColor, STRING
The outline color of each bar in the bar graph. Only active if :opt:`graphBar <graphBar, BOOLEAN>` is passed. Default: ```black'``.
The outline color of each bar in the bar graph. Only active if
:opt:`graphBar <graphBar, BOOLEAN>` is passed. Default:
```black'``.
.. option:: graphBarFillColor, STRING
The fill color of each bar in the bar graph. Only active if :opt:`graphBar <graphBar, BOOLEAN>` is passed. Default: ```black'``.
The fill color of each bar in the bar graph. Only active if
:opt:`graphBar <graphBar, BOOLEAN>` is passed. Default:
```black'``.
.. option:: graphBarWidth, DOUBLE
The width of each bar in the bar graph. Only active if :opt:`graphBar <graphBar, BOOLEAN>` is passed. Default: ``2``.
The width of each bar in the bar graph. Only active if
:opt:`graphBar <graphBar, BOOLEAN>` is passed. Default: ``2``.
.. option:: graphHline, DOUBLE
Use this option to draw a horizontal line at the given value. Default: ``empty``.
Use this option to draw a horizontal line at the given
value. Default: ``empty``.
.. option:: graphLegendName, STRING
The name to display in the legend for this series, passed as valid LaTeX (e.g., ``GDP_{US}, $\alpha$, \color{red}GDP\color{black}``). Will be displayed only if the ``data`` and :opt:`showLegend <showLegend, BOOLEAN>` options have been passed. Default: the tex name of the series.
The name to display in the legend for this series, passed as
valid LaTeX (e.g., ``GDP_{US}, $\alpha$,
\color{red}GDP\color{black}``). Will be displayed only if the
``data`` and :opt:`showLegend <showLegend, BOOLEAN>` options
have been passed. Default: the tex name of the series.
.. option:: graphLineColor, STRING
Color to use for the series in a graph. See the explanation in :opt:`shadeColor <shadeColor, STRING>` for how to use colors with reports. Default: ```black'``
Color to use for the series in a graph. See the explanation in
:opt:`shadeColor <shadeColor, STRING>` for how to use colors
with reports. Default: ```black'``
.. option:: graphLineStyle, OPTION
@ -440,7 +605,8 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: graphMarker, OPTION
The Marker to use on this series in a graph. Possible values for OPTION are::
The Marker to use on this series in a graph. Possible values
for OPTION are::
`x' | `+' | `-' | `|' | `o' | `asterisk' | `star' | `10-pointed star' |
`oplus' | `oplus*' | `otimes' | `otimes*' | `square' | `square*' |
@ -453,11 +619,15 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: graphMarkerEdgeColor, STRING
The edge color of the graph marker. See the explanation in :opt:`shadeColor <shadeColor, STRING>` for how to use colors with reports. Default: ``graphLineColor``.
The edge color of the graph marker. See the explanation in
:opt:`shadeColor <shadeColor, STRING>` for how to use colors
with reports. Default: ``graphLineColor``.
.. option:: graphMarkerFaceColor, STRING
The face color of the graph marker. See the explanation in :opt:`shadeColor <shadeColor, STRING>` for how to use colors with reports. Default: ``graphLineColor``.
The face color of the graph marker. See the explanation in
:opt:`shadeColor <shadeColor, STRING>` for how to use colors
with reports. Default: ``graphLineColor``.
.. option:: graphMarkerSize, DOUBLE
@ -465,39 +635,63 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: graphMiscTikzAddPlotOptions, STRING
If you are comfortable with ``PGFPLOTS/TikZ``, you can use this option to pass arguments directly to the ``PGFPLOTS/TikZ`` ``addPlots`` command. (e.g., Instead of passing the marker options above, you can pass a string such as the following to this option: ```mark=halfcircle*,mark options={rotate=90,scale=3}'``). Specifically to be used for desired ``PGFPLOTS/TikZ`` options that have not been incorporated into Dynare Reproting. Default: ``empty``.
If you are comfortable with ``PGFPLOTS/TikZ``, you can use
this option to pass arguments directly to the
``PGFPLOTS/TikZ`` ``addPlots`` command. (e.g., Instead of
passing the marker options above, you can pass a string such
as the following to this option: ```mark=halfcircle*,mark
options={rotate=90,scale=3}'``). Specifically to be used for
desired ``PGFPLOTS/TikZ`` options that have not been
incorporated into Dynare Reproting. Default: ``empty``.
.. option:: graphShowInLegend, BOOLEAN
Whether or not to show this series in the legend, given that the :opt:`showLegend <showLegend, BOOLEAN>` option was passed to :repmeth:`addGraph`. Default: ``true``.
Whether or not to show this series in the legend, given that
the :opt:`showLegend <showLegend, BOOLEAN>` option was passed
to :repmeth:`addGraph`. Default: ``true``.
.. option:: graphVline, dates
Use this option to draw a vertical line at a given date. Default: ``empty``.
Use this option to draw a vertical line at a given
date. Default: ``empty``.
.. option:: tableDataRhs, dseries
A series to be added to the right of the current series. Usefull for displaying aggregate data for a series. e.g if the series is quarterly ``tableDataRhs`` could point to the yearly averages of the quarterly series. This would cause quarterly data to be displayed followed by annual data. Default: ``empty``.
A series to be added to the right of the current
series. Usefull for displaying aggregate data for a
series. e.g if the series is quarterly ``tableDataRhs`` could
point to the yearly averages of the quarterly series. This
would cause quarterly data to be displayed followed by annual
data. Default: ``empty``.
.. option:: tableRowColor, STRING
The color that you want the row to be. Predefined values include ``LightCyan`` and ``Gray``. Default: ``white``.
The color that you want the row to be. Predefined values
include ``LightCyan`` and ``Gray``. Default: ``white``.
.. option:: tableRowIndent, INTEGER
The number of times to indent the name of the series in the table. Used to create subgroups of series. Default: ``0``.
The number of times to indent the name of the series in the
table. Used to create subgroups of series. Default: ``0``.
.. option:: tableShowMarkers, BOOLEAN
In a Table, if ``true``, surround each cell with brackets and color it according to :opt:`tableNegColor <tableNegColor, LATEX_COLOR>` and :opt:`tablePosColor <tablePosColor, LATEX_COLOR>`. No effect for graphs. Default: ``false``.
In a Table, if ``true``, surround each cell with brackets and
color it according to :opt:`tableNegColor <tableNegColor,
LATEX_COLOR>` and :opt:`tablePosColor <tablePosColor,
LATEX_COLOR>`. No effect for graphs. Default: ``false``.
.. option:: tableAlignRight, BOOLEAN
Whether or not to align the series name to the right of the cell. Default: ``false``.
Whether or not to align the series name to the right of the
cell. Default: ``false``.
.. option:: tableMarkerLimit, DOUBLE
For values less than :math:`-1*\texttt{tableMarkerLimit}`, mark the cell with the color denoted by tableNegColor. For those greater than ``tableMarkerLimit``, mark the cell with the color denoted by tablePosColor. Default: ``1e-4``.
For values less than :math:`-1*\texttt{tableMarkerLimit}`,
mark the cell with the color denoted by tableNegColor. For
those greater than ``tableMarkerLimit``, mark the cell with
the color denoted by tablePosColor. Default: ``1e-4``.
.. option:: tableNaNSymb, STRING
@ -505,36 +699,47 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: tableNegColor, LATEX_COLOR
The color to use when marking Table data that is less than zero. Default: ```red'``
The color to use when marking Table data that is less than
zero. Default: ```red'``
.. option:: tablePrecision, INTEGER
The number of decimal places to report in the table data. Default: the value set by :opt:`precision <precision, INTEGER>`.
The number of decimal places to report in the table
data. Default: the value set by :opt:`precision <precision,
INTEGER>`.
.. option:: tablePosColor, LATEX_COLOR
The color to use when marking Table data that is greater than zero. Default: ```blue'``
The color to use when marking Table data that is greater than
zero. Default: ```blue'``
.. option:: tableSubSectionHeader, STRING
A header for a subsection of the table. No data will be associated with it. It is equivalent to adding an empty series with a name. Default: ``''``
A header for a subsection of the table. No data will be
associated with it. It is equivalent to adding an empty series
with a name. Default: ``''``
.. option:: zeroTol, DOUBLE
The zero tolerance. Anything smaller than ``zeroTol`` and larger than ``-zeroTol`` will be set to zero before being graphed or written to the table. Default: ``1e-6``.
The zero tolerance. Anything smaller than ``zeroTol`` and
larger than ``-zeroTol`` will be set to zero before being
graphed or written to the table. Default: ``1e-6``.
.. repmethod:: addParagraph
.. reportingmethod:: addParagraph
Adds a ``Paragraph`` to a ``Section``.
|br| Adds a ``Paragraph`` to a ``Section``.
NB: The ``Section`` can only be comprised of ``Paragraphs`` and must only have 1 column.
The ``Section`` can only be comprised of ``Paragraphs`` and must
only have 1 column.
*Options*
.. option:: balancedCols, BOOLEAN
Determines whether the text is spread out evenly across the columns when the ``Paragraph`` has more than one column. Default: ``true``.
Determines whether the text is spread out evenly across the
columns when the ``Paragraph`` has more than one
column. Default: ``true``.
.. option:: cols, INTEGER
@ -542,7 +747,9 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: heading, STRING
The heading for the ``Paragraph`` (like a section heading). The string must be valid LaTeX code. Default: ``empty``.
The heading for the ``Paragraph`` (like a section
heading). The string must be valid LaTeX code. Default:
``empty``.
.. option:: indent, BOOLEAN
@ -550,12 +757,13 @@ Below, you will see a list of methods available for the Report class and a clari
.. option:: text, STRING
The paragraph itself. The string must be valid LaTeX code. Default: ``empty``.
The paragraph itself. The string must be valid LaTeX
code. Default: ``empty``.
.. repmethod:: addVspace
.. reportingmethod:: addVspace
Adds a ``Vspace`` (vertical space) to a ``Section``.
|br| Adds a ``Vspace`` (vertical space) to a ``Section``.
*Options*
@ -568,33 +776,47 @@ Below, you will see a list of methods available for the Report class and a clari
The number of new lines to be inserted. Default: ``1``.
.. repmethod:: write
.. reportingmethod:: write
Writes the LaTeX representation of this ``Report``, saving it to the file specified by :opt:`filename <fileName, FILENAME>`.
|br| Writes the LaTeX representation of this ``Report``, saving it
to the file specified by :opt:`filename <fileName, FILENAME>`.
.. repmethod:: compile
.. reportingmethod:: compile
Compiles the report written by ``write`` into a ``pdf`` file. If the report has not already been written (determined by the existence of the file specified by :opt:`filename <fileName, FILENAME>`, ``write`` is called.
|br| Compiles the report written by ``write`` into a ``pdf``
file. If the report has not already been written (determined by
the existence of the file specified by :opt:`filename <fileName,
FILENAME>`, ``write`` is called.
*Options*
.. option:: compiler, FILENAME
Like :opt:`compiler <compiler, FILENAME>`, except will not overwrite the value of ``compiler`` contained in the report object. Hence, passing the value here is useful for using different LaTeX compilers or just for passing the value at the last minute.
Like :opt:`compiler <compiler, FILENAME>`, except will not
overwrite the value of ``compiler`` contained in the report
object. Hence, passing the value here is useful for using
different LaTeX compilers or just for passing the value at the
last minute.
.. option:: showOutput, BOOLEAN
Print the compiler output to the screen. Useful for debugging your code as the LaTeX compiler hangs if there is a problem. Default: the value of :opt:`showOutput <showOutput, BOOLEAN>`.
Print the compiler output to the screen. Useful for debugging
your code as the LaTeX compiler hangs if there is a
problem. Default: the value of :opt:`showOutput <showOutput,
BOOLEAN>`.
.. option:: showReport, BOOLEAN
Open the compiled report (works on Windows and macOS on Matlab). Default: ``true``.
Open the compiled report (works on Windows and macOS on
Matlab). Default: ``true``.
*Example*
The following code creates a one page report. The first part of the page contains two graphs displayed across two columns and one row. The bottom of the page displays a centered table::
The following code creates a one page report. The first part of the
page contains two graphs displayed across two columns and one row. The
bottom of the page displays a centered table::
%% Create dseries
dsq = dseries(`quarterly.csv');