help mata Elabel_eExp()

Title

Elabel_eExp() -- Manipulate elabel eexpression (class)

Syntax

class Elabel_eExp scalar e

void
e.eexp(string scalar eexp)

transmorphic colvector
e.eexp()

void
e.wildcards(real colvector hash,
string colvector at)

real colvector
e.hash()

string colvector
e.at()

string colvector
e.atbs()

real scalar
e.hashash()

real scalar
e.hasat()

string scalar
e.eexp_asis()

real scalar
e.get_rc()

Description

Elabel_eExp() returns instances of class Elabel_eExp;
Elabel_eExp() extends
Elabel_Utilities(). The class is
used for developing the elabel package. See
elabel_u_eexp() for the corresponding Mata
function.

e.eexp(string scalar eexp) sets an eexp
that may contain the wildcard characters # and @.

e.eexp() obtains a previously set eexp with all wildcard
characters replaced and evaluated by Stata. If eexp evaluates to a
numeric scalar (or vector) the result is real scalar
(or real colvector); if eexp evaluates to a string scalar
(or vector) the result is string scalar (or string colvector). The
function returns J(1, 1, "") if eexp is "".

e.wildcards() sets the real colvector and
string colvector that replace the respective wildcard characters in
eexp. Both are initalized as missing scalars. In general, hash
and at must have the same number of rows. However, if hash is
r x 1 and at is 1 x 1, the latter is replaced with
J(r, 1, at). The same applies the other way
round, if at is r x 1 and hash is 1 x 1.

e.hash() and e.at() are used to obtain the currently
set real colvector and string colvector that replace the
respective wildcard characters in eexp.

e.atbs() returns e.at() with all single left quotes
prefixed with a backslash.

e.hashash() and e.hasat() indicate whether
eexp contains the respective wildcard characters. Both functions take
an optional real scalar argument that, if set to 0, exits with a Stata
error message if eexp contains # or @, respectively.

e.eexp_asis() returns eexp as previously set, including
all wildcard characters.

e.get_rc() returns the Stata return code when evaluating eexp.

Conformability

As indicated above.

Diagnostics

e.eexp() produces Stata error messages when eexp
cannot be evaluated by Stata. Other functions might produce Mata
traceback logs.

Source code

Distributed with the elabel package.

Author

Daniel Klein

University of Kassel

klein.daniel.81@gmail.com

Also see

Online: mata

if installed: elabel