*! version 2012-08-31 scott long

Title

_rm_modelinfo --
Returns information about the model that has e-returns in memory.

Syntax

_rm_modelinfo

Description

_rm_modelinfo is a programmer's tool that returns information about
the estimation command that has e-returns in memory.

One way to see the information returned is by including: _rm_modelinfo.doi

Alternatively:

_rm_modelinfo

sreturn list

foreach s in cmdnm cmdbin cmdnrm cmdsvy cmdn lhsnm lhsvalues lhscatn ///
lhscatnms lhscatvals rhsnms rhsn rhsnms2 rhsn2 ///
rhsfvtypes rhsfvtypes2 {

di "`s': " _col(20) "`s(`s')'"
}

Saved results

_rm_modelinfo saves in s():

Macros:

s(cmdnm) Estimation command name

s(cmdbin) 1 if binary model

s(cmdnrm) 1 if mprobit or mlogit

s(cmdsvy) 1 if svy command

s(cmdn) Sample size

s(lhsnm) Name of lhs variable

s(lhsvalues) # of values for lhs variable in e(sample)

s(lhscatn) # of cateogies returned by e(k_cat)

s(lhscatnms) names of lhs categories

s(lhscatvals) values of categories

s(rhsnms) names of 1st rhs equation

s(rhsn) # of rhs variables

s(rhsnms2) names of 2nd equation

s(rhsn2) # of rhs vars in the second equation

s(rhs2_core) unique set of variables on the rhs inflation portion

s(rhs2_notfv) variables not used as factor variables

s(rhs2_fv) variables used as factor variables

s(rhs2_fvbin) variables used as i1. type factor variables

s(rhs2_fvcat) variables used as i2., i3., ... type factor variables

s(rhs2_fvint) variables used in # terms

s(rhs2_fvintself) variables used in # with themselves (e.g., c.age#c.age)

s(rhs2_fvintselfonly) variables used in # only with self but no other variables
(e.g., not c.age#i.wc)

s(rhs2_fvintother) variables used in # with other varvariables
(e.g., c.age#i.wc)

Also see

_rm for other _rm programming commands.