help mata Elabel_Options__()

Title

Elabel_Options__() -- Manage elabel options (class)

Syntax

class Elabel_Options__ scalar o

void
o.st_get()

void
o.st_get_aa()

void
o.st_get_mm()

void
o.st_get_options()

real scalar
o.add()

real scalar
o.modify()

real scalar
o.replace()

real scalar
o.fixfmt()

real scalar
o.nomem()

real scalar
o.current()

string scalar
o.st_options([real scalar comma])

string scalar
o.printamrnf([real scalar comma])

string scalar
o.print_opts([real scalar comma])

real scalar
o.aa()

real scalar
o.mm()

string scalar
o.sep()

Description

Elabel_Options__() returns instances of
class Elabel_Options__. The class is used
for developing the elabel package.

o.st_get() obtains the settings for all options, except
append, merge0, and merge(), from the respective
Stata local macros; the function is usually called after
u.u_st_syntax() or a direct
call to Stata's syntax. If replace is combined with
add or modify, the respective Stata error message is
issued. If modify is specified, add is set to false
(o.add()==0).

o.st_get_aa() and o.st_get_mm() obtain the
settings for options append, merge0, and merge()
from the respective Stata local macros; the function is usually called
after o.st_get(). If append is specified with one of
modify or replace, or if append is specified without
add, a Stata error message is issued. If merge is specified
with replace, or if merge is specified without modify,
a Stata error message is issued. Also, if merge() is specified with
more than one word, a Stata error message is issued. Option merge()
should be specified in the syntax command as
MERGE(string asis).

o.st_get_options() obtains st_local("options").

o.add(), o.modify(), o.replace() are
called after o.st_get() and return the settings of the
respective options.

o.fixfmt() is called after o.st_get();
o.fixfmt() is the counterpart of option nofix. If
nofix is specified, o.fixfmt()==0.

o.nomem() and o.current() are called after
o.st_get() and return the settings of the respective
options. If current is specified, nomem is set to true
(o.nomem()!=0).

o.st_options() is called after o.st_get() and
returns any additional options as specified, preceded by a comma.

o.printamrnf() is called after o.st_get() and
returns whichever of add modify replace nofix was specified,
preceded by a comma.

o.print_opts() is called after o.st_get() and
returns o.printamrnf() + o.st_options().

o.aa(), o.mm(), and o.sep() are called
after o.st_get_aa() and o.st_get_mm() and return the
settings of the respective options. o.sep() returns
char(32), i.e., " ", if merge0 was specified
without merge().

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