Stata 15 help for _get_diparmopts


[P] _get_diparmopts -- Parsing and display utility


_get_diparmopts [, diparmopts(diparm_options) execute bottom plus global_diparm_options ]

_get_diparmopts , soptions [ diparmopts(options) execute bottom plus global_diparm_options ]

where options is any collection of options (including diparm_options), diparm_options contains one or more of


diparm_args is either "__sep__" or anything allowed by the _diparm (see [P] _diparm) command (except the level(#) option), and global_diparm_options is one or more of

level(#) dof(#)


_get_diparmopts is a programming tool, written to help parse and display multiple transformations of parameter estimates using the _diparm utility; see [P] _diparm.

_get_diparmopts will place the supplied global_diparm_options into each supplied diparm() option. This makes it easier to specify the diparm() options without having to specify a common option throughout. If dof() is not specified, _get_diparmopts will use e(df_r) if it contains a positive integer value.


diparmopts(options) contains options to be parsed. Of particular interest are diparm() options, the contents of which will be passed on to the _diparm utility.

execute indicates that _get_diparmopts execute _diparm for each diparm() option specified in diparmopts(), using the order in which they appear in diparmopts(). It is possible to place separator lines by supplying diparm(__sep__).

By default (when execute is not specified), _get_diparmopts will only check the syntax, returning the diparm() options in s(diparm) and all other options in s(options).

soptions indicates that _get_diparmopts allow other options beside diparm() within diparmopts(), and will place them in s(options). soptions is ignored when the execute option is supplied.

bottom indicates that nothing more will be added to the table, so the bottom separation line is drawn.

plus is equivalent to placing a diparm(__sep__) as the last option supplied to diparmopts(). A bottom separation line is added to the table with a + symbol at the position of the dividing line between variable names and results. This is useful if you plan on adding more output to the table.

global_diparm_options are a subset of options allowed by _diparm, and when specified are added to the individually specified diparm() options, both when parsed and executed.


. _get_diparmopts, soptions diparmopts( diparm(lnsigma) diparm(lnsigma, exp label("sigma")) junk ) . sreturn list

macros: s(diparm) : " diparm(lnsigma) diparm(lnsigma, exp label("sigma")) > " s(options) : "junk"

. _get_diparmopts, execute diparmopts(diparm(lnsigma) diparm(lnlambda))

/lnsigma | 3 3 1.00 0.317 -2.879892 8.879892 /lnlambda | 4 4 1.00 0.317 -3.839856 11.83986 --------------------------------------------------------------------------

. _get_diparmopts, execute /// diparmopts( diparm(lnsigma) diparm(__sep__) diparm(lnlambda) )

/lnsigma | 3 3 1.00 0.317 -2.879892 8.879892 -------------+------------------------------------------------------------ /lnlambda | 4 4 1.00 0.317 -3.839856 11.83986 --------------------------------------------------------------------------

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