.-
help for ^hilite2^                                                (STB-50: gr38)
.-

Highlight subsets of points in a two-way scatterplot
----------------------------------------------------

    ^hilite2^ yvar xvar [^if^ exp] [^in^ range]^,^
                { ^hil^ite^(^exp-list^)^ | ^hiv^ar^(^zvarlist^)^ }
                [ ^miss^ { ^o^verlay | ^mat^rix } ^mar^gin^(^#^) sy^mbol^(^str^) nola^bel
                  ^sa^ving^(^filename^)^ ^t1^title^(^str^) bs^ize^(^#^)^ graph_options ]


Description
-----------

^hilite2^ draws one or more two-way scatterplot highlighting the observations
selected explictly by expressions, or implicitly by the values of a varlist
zvarlist. Multiple plots may be overlaid or plotted in a matrix plot.


Options
-------

^hilite(^exp-list^)^ specifies a list of expressions, separated by blanks, to be
    highlighted. The expressions should not contain embedded spaces.

^hivar(^varlist^)^ specifies a varlist so that observations with the same
    values for variables in varlist, are highlighted. The variables may be
    numeric or string-typed.

^miss^ specifies that observations with missing values of the hivar-varlist
    should be treated as a separate hilite group

^overlay^ specifies that the highlights for all expressions should be plotted
    in a single `overlay' plot. In an overlay plot, at most 6 expressions
    should be implied by ^hilite^ or ^hivar^.

^matrix^ specifies that a matrix plot is produced of separate hilite plots
    for each explicit or implicit expression. For readability, vertical and
    horizontal labels are only displayed in the left-most and down-most plots.
    At most 49 expressions should be implied by ^hilite^ or ^hivar^.

^symbol(^str^)^ specifies the symbols used to hilite expressions (see ^symbols()^
    in ^help graph^). If a matrix plot is produced, str should contain at most
    2 characters. In an overlay plot, the number of characters in str should
    equal the number of expressions to be highlighted.

^nolabel^ specifies that the titles describing the highlighting expressions
    for ^hivar^-induced hilite groups ignore value labels. This may be useful
    if the resulting expressions are too long.

^margin(^#^)^ specifies the margin for a matrix-style plot.

^saving(^filename^)^ specifies the overlay plot or the matrix plot should be
    saved in a file named filename.

^title(^str^)^ specifies the title displayed in the combined matrix plot.

^bsize(^#^)^ specifies the plot size of the title describing the hilite
    expression.

graph_options are any of the options allowed with ^graph, twoway^; see
    help @graph@. In case of matrix plot, these options are applied to each of
    the 2-way scattergrams, not to be combined plot. Even ^by()^ is permitted
    but usually leads to an ugly plot.


Examples
--------

   . ^hilite2 tempjan tempjuly, hilite(region==1)^
   . ^hilite2 tempjan tempjuly, hilite(region==1) ylabel xlabel^
   . ^hilite2 tempjan tempjuly, hilite(reg==2, reg==3|reg=4)^
   . ^hilite2 tempjan tempjuly, hivar(region) overlay^
   . ^hilite2 tempjan tempjuly, hivar(region year)^


Author
------

        Jeroen Weesie
        Dept of Sociology/ICS
        Utrecht University
        J.Weesie@@fss.uu.nl


Also see
--------

    STB:  STB-50 gr38
 Manual:  [R] hilite
On-line:  help for @graph@