[U] User's Guide

18 Programming StataContents18.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20218.2 Relationship between a program and a do-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20218.3 Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20518.3.1 Local macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20618.3.2 Global macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20718.3.3 The difference between local and global macros . . . . . . . . . . . . . . . . . . . . . . 20718.3.4 Macros and expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20818.3.5 Double quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20918.3.6 Extended macro functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21118.3.7 Macro increment and decrement functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 21218.3.8 Macro expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21318.3.9 Advanced local macro manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21418.3.10 Advanced global macro manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21518.3.11 Constructing Windows filenames by using macros . . . . . . . . . . . . . . . . . . . . 21618.3.12 Accessing system values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21618.3.13 Referring to characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21618.4 Program arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21718.4.1 Named positional arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21918.4.2 Incrementing through positional arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 22018.4.3 Using macro shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22218.4.4 Parsing standard Stata syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22318.4.5 Parsing immediate commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22418.4.6 Parsing nonstandard syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22518.5 Scalars and matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22618.6 Temporarily destroying the data in memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22618.7 Temporary objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22618.7.1 Temporary variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22718.7.2 Temporary scalars and matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22718.7.3 Temporary files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22818.8 Accessing results calculated by other programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22818.9 Accessing results calculated by estimation commands . . . . . . . . . . . . . . . . . . . . . . . . . . 23118.10 Saving results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23218.10.1 Saving results in r() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23318.10.2 Saving results in e() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23418.10.3 Saving results in s() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23718.11 Ado-files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23718.11.1 Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23918.11.2 Comments and long lines in ado-files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23918.11.3 Debugging ado-files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24018.11.4 Local subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24018.11.5 Development of a sample ado-command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24218.11.6 Writing online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24718.11.7 Programming dialog boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25318.12 A compendium of useful commands for programmers . . . . . . . . . . . . . . . . . . . . . . . . . 25318.13 References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253201