IRIS Toolbox Reference Manual

series

Add new data to graph or table

Syntax

P.series(Cap,X,...)

Input arguments

Options for both table series and graph series

Options for table series

Options for graph series

Generic options

See help on generic options in report objects.

Description

Using the options 'nan=', 'inf=', 'pureZero=' and 'printedZero='

When specifying the LaTeX string for these options, bear in mind that the table entries are printed in the math model. This means that whenever you wish to print a normal text, you need to use an appropriate text formatting command allowed within a math mode. Most frequently, it would be '\textnormal{...}'.

Using the option 'plotFunc='

When you set the option to 'plotpred', the input data X (second input argument) must be a multicolumn tseries object where the first column is the time series observations, and the second and further columns are its Kalman filter predictions as returned by the filter function.

Conditional formatting

The conditional format struct (or an array of structs) specified through the 'condFormat=' option must have two fields, .test and .format.

The .test field is a text string with a Matlab expression. The expression must evaluate to a scalar true or false, and can refer to the following attributes associated with each entry in the data part of the table:

If the table is based on user-defined structure of columns (option 'colstruct=' in table), the following additional attributes are available

You can combine a number of attribues within one test, using the logical operators, e.g.

'value > 0 && year > 2010'

The .format fields of the conditional format structure consist of LaTeX commands that will be use to typeset the corresponding entry. The reference to the entry itself is through a question mark. The entries are typeset in math mode; this for instance meanse that for bold or italic typface, you must use the \mathbf{...} and \mathit{...} commands.

In addition to standard LaTeX commands, you can use the following IRIS-specific commands in the format strings:

You can combine multiple tests and their correponding formats in one structure; they will be all applied to each entry in the specified order.

LHS-RHS plots

The LHS-RHS report graphs are still an experimental feature.

When the option 'yAxis=' is used to plot on both the LHS and the RHS y-axis, the plot functions are restricted to @plot, @bar, @area and @stem. Also, because of a bug in Matlab, always control the color of the lines, bars and areas in all LHS-RHS graphs: use either the option 'plotOptions=' in this command, or 'style=' in the respective graph command.

Example (Conditional format structure)

Typeset negative values in italic, and values in periods before 2010Q1 blue:

cf = struct();
cf(1).test = 'value < 0';
cf(1).format = '\mathit{?}';
cf(2).test = 'date < qq(2010,1)';
cf(2).format = '\color{blue}';