.-
help for ^biv^                                 (STB-45: ip26)
.-

Bivariate results for each pair of variables in a varlist
---------------------------------------------------------

    ^biv^ progname [varlist] [weight] [^if^ exp] [^in^ range]
    [ ^, a^sy ^c^on ^e^cho ^he^ader^(^string^) hs^tart^(^#^)^
    ^o^wn^(^string^) p^ause ^q^uiet progname_options ]


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

^biv^ displays bivariate results for each pair of distinct variables in
the varlist. For p variables there will be p(p-1)/2 such pairs if the
order of the variables is immaterial and p(p-1) otherwise.

In the simplest cases

    ^biv^ progname

    ^biv^ progname varlist

progname specifies a command or program that takes a pair of variables
and produces its own results

and varlist is a list of variables (which is optional).


Remarks
-------

^biv^ could lead to a lot of output if p is large and/or the results of
progname are bulky. If p is 100, there are 4950 pairs if the order of
the variables is immaterial and 9900 pairs otherwise. Consider the
effects on paper and patience, your own and your institution's.


Options
-------

^asy^ flags that the results of progname var1 var2 may differ from those
    of progname var2 var1 and that both sets are wanted.

^con^ suppresses the new line that would normally follow the variable
    names echoed by ^echo^. Thus other output (typically from the user's
    own program) may follow on the same line.

^echo^ echoes the variable names to the monitor.

^header(^string^)^ specifies a header string that will be displayed
    first before any bivariate results.

^hstart(^#^)^ specifies the column in which the header will start. Its
    default is 21.

^own(^own_command_name^)^ allows users to insert their own command
    dealing with the output from progname.

^pause^ pauses output after each execution of progname. This may be
    useful, for example, under Stata for Windows when progname is ^graph^.

^quiet^ suppresses output from progname. This is likely to be useful only
    if the user arranges that output is picked up and shown in some way
    through the ^own^ option.

progname_options are the options of progname, if such exist.


Examples
--------

        . ^biv graph length displ weight, xla yla^
        . ^biv spearman length displ weight^

        . ^biv concord, qui echo con own(dispcon)^
               ^he(rho_c se of rho_c bias correction)^

In the last example, ^dispcon^ is a program that picks up the global
macros S_2, S_3 and S_8 left behind by ^concord^:

^program define dispcon^
    ^version 5.0^
    ^di %6.3f $S_2 %9.3f $S_3 %13.3f $S_8^
^end^


Author
------

        Nicholas J. Cox
        University of Durham, U.K.
        n.j.cox@@durham.ac.uk


Also see
--------

    STB:  ip26 (STB-45)
On-line:  help for @concord@ (if installed)