help mata Elabel_Unab()

Title

Elabel_Unab() -- Unabbreviate value label names (class)

Syntax

class Elabel_Unab scalar u

string rowvector
u.unab(string scalar lblname)

string rowvector
u.unab(string scalar lblname, newlblname)

void
u.nomem(real scalar val)

real scalar
u.nomem()

void
u.abbrv(real scalar val)

real scalar
u.abbrv()

void
u.mlang(real scalar val)

real scalar
u.mlang()

void
u.nonamesok(real scalar val)

real scalar
u.nonamesok()

where val evaluates to true (val!=0) or false (val==0).

Description

Elabel_Unab() returns instances of class Elabel_Unab;
Elabel_Unab() extends
Elabel_Dir(). The class is used
for developing the elabel package. See
elabel_unab() for the corresponding Mata
function.

u.unab(lblname) returns lblname
unabbreviated or errors out with the corresponding Stata
error message.

u.unab(lblname, newlblname)
returns lblname unabbreviated and replaces newlblname
with J(1, 0, ""), or, if lblname could not be matched,
puts lblname into newlblname and returns J(1, 0, "").

u.nomem() specifies how to treat nonexistent value
labels. The default is to treat nonexistent value labels as such,
i.e., nomem==0. The complementary u.mlang() is
inherited from Elabel_Dir().

u.abbrv() specifies whether value label names may be
abbreviated. The default setting is val=0, meaning value label
names may not be abbreviated.

u.nonamesok(), if val!=0, causes unab() to exit
with a Stata error message if no value labels are stored in memory. The
default setting is val=1.

Conformability

As indicated above.

Diagnostics

Not documented; class functions are for internal use.

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