<< pltms_yyhat Printings and graphs pltseries0 >>

Grocer >> Printings and graphs > pltseries

pltseries

2d plot

CALLING SEQUENCE

pltseries(arg1,...,argn)

PARAMETERS

Input

* argi =

  - the series to graph, which can take any of these types:

    . a time series

    . a real (n x p) vector

    . a string equal to the name of a time series or a (n x p) real vector between quotes

    . a matrix or a list of such elements

optional arguments:

  - 'title=x' if the user wants to give its own title (default: the name of the ts if it has been given between quotes, the string 'ts' if not)

  - 'bounds=[''b1'' ; ''b2'' ;...; ''bn'']' if the user wants to give its own grocer_bounds (default: the whole series)

  - 'yaxex=xx' if the user wants to put the x axis at value xx (default: y minimum value)

  - 'yaxis=xx' where xx is a (1 x p) matrix of 1 and 2, if the user wants 2 axes, respectively at the left and the right of the graph; the j the series is represented on the left axis if xx(j)==1 and on the right one if xx(j)==2 (default: only a left axis)

  - 'bars = xx' with xx integer row vector of size p representing the nature of the representation of the series (1=bars; anything else = curves)

  - 'x0(1)=xx' with xx integer representing the x location of the first y axis (default: put at x=1)

  - 'x0(2)=xx' with xx integer representing the x location of the second y axis (default: put at x=nobs)

  - 'x=xx' where xx is the (1 x nobs) string vector to put on the x axis

  - 'styleg = xx' with xx integer representing the location of the legend (default: 5, that is the legend is placed interactively with the mouse, see legends in the help menu)

  - 'color = xx' with xxinteger row vector of size p representing the line color of each series

  - 'mycolor=[r1,g1,b1;...;rp,gp,bp]' for user defined colors with ri,gi,bi the RGB integer values of a color

  - 'shade=xx' a (n x 1) vector composed of 0 and 1 where the ones delimit areas to be shaded

  - 'style = xx' with xx' integer row vector of size p representing the line style of each series

  - 'thickn = xx' with xx integer vector of size p representing the thickness of the line drawn for each series (default all equal to 1)

  - 'legend = xx' with xx title of the legend

  - 'yaxis = xx' with xx integer row vector of size p representing the axis for each series (1=left; 2=right)

  - 'bars = xx' with xx integer row vector of size p representing the nature of the representation of the series (1=bars; anything else = curves)

  - 'ntics=xx' with xx an integer representing number of of tics between 2 occurences of the axis values

  - 'font_title=xx' with xx the size of the title font

  - 'font_axis=xx' with xx the size of the axis font

  - 'font_legend=xx' with xx the size of the legend font

  - 'style_title=xx' with xx the font style of the title

  - 'window=x' if the user wants to specify the # x where the graph is plotted (default: the window 1)

  - 'just_scale=bool' with bool a boolean which is:

    . %T if you want the y scale to be exactly the length [min(y),max(y)]

    . %F if you want the y scale to begin and end with rounded numbers (default)

 

Output

* nothing (printed on a graphic window)

DESCRIPTION

Plots series... This function allows the user to make some complex graphs by gathering in one function some capabilities emboddied in scilab graphic functions drawaxis, legend and xset. The user can graph vectors and martrices, as with plot2d, but also timeseries. She can choose to use 2 y axes instead of one by setting the option 'yaxis=...'. She can choose the position of the x axis with the option 'yaxex=...'. She can control the color and style of the lines and the location of the legend.

EXAMPLE

load(GROCERDIR+'/data/bdhenderic.dat');
pltseries('delts(lm1)','delts(lp)')
// the simplest use of pltseries: only the series (here ts) are entered.
 
pltseries('ly+lp-lm1','rnet','title=money velocity and interest rate',...
'yaxis=[1 2 ]','legend=[money velocity (lhs);interest rate (rhs)','color=[2 6]','styleg=3',...
'window=3','bounds=[''1968q1'';''1985q4'']')
// a complex use: the user chooses her legend, title, colors, style and ts bounds. The legend is drawn
// in the lower left-hand corner. The first series is represented along the lhs x scale and the second one along the rhs
// y axis.

AUTHOR

Eric Dubois 2002-2006

Report an issue
<< pltms_yyhat Printings and graphs pltseries0 >>