Stata 15 help for mlopts

Title

[P] mlopts -- Parsing tool for ml commands

Syntax

mlopts mlopts [rest] [, options ]

Description

mlopts is a parsing tool that was written to assist in syntax checking and parsing of estimation commands that use ml. The options specified in options will be separated into groups and returned in local macros specified by the caller. The names of the local macros are identified by mlopts and rest.

mlopts is required and will contain those options that the ml command recognizes as maximize options. Options returned in mlopts are

trace gradient hessian showstep technique(algorithm_specs) vce(oim|opg|robust) iterate(#) tolerance(#) ltolerance(#) nrtolerance(#) qtolerance(#) nonrtolerance showtolerance difficult constraints(clist|matname) collinear nocnsnotes

For a description of the above options (except constraints()), see [R] maximize. For a description of constraints, see [R] cnsreg and [R] reg3.

rest is optional and, if specified, will contain all other options that were not returned in mlopts. If rest is not specified, then any extra options will cause an error.

Some official Stata commands that use mlopts

The following commands use mlopts. See help for

arch, arima, biprobit, boxcox, cloglog, etregress, frontier, glm, gnbreg, heckman, heckprobit, hetprobit, hetregress, intreg, nbreg, nlogit, poisson, rocfit, scobit, svar, truncreg, tssmooth, xtcloglog, xtfrontier, xtintreg, xtlogit, xtnbreg, xtpoisson, xtprobit, xtrchh, xttobit, zinb, zip

Examples

. mlopts mlopts, constraints(1/3)

. mlopts mlopts, constraints(1/3) junk option junk not allowed r(198);

. mlopts mlopts options, constraints(1/3) junk

. sreturn list

macros: s(constraints) : "1 2 3"

Stored results

mlopts stores the following in s():

Macros:

s(constraints) contents of constraints() option s(collinear) collinear, if option was specified s(technique) contents of technique() option


© Copyright 1996–2018 StataCorp LLC   |   Terms of use   |   Privacy   |   Contact us   |   What's new   |   Site index