-------------------------------------------------------------------------------
help for examples, wexamples 
-------------------------------------------------------------------------------

Show examples from on-line help files

examples topicname

wexamples topicname

examples function()

wexamples function()

Description

examples looks for help on topicname and displays any Examples sections found in the Results window. Alternatively, examples looks for help on function() (note the parentheses) and displays a definition in the Results window. It is especially designed to show quick and easy reminders of the syntax of a given command.

wexamples is identical except that output appears in the Viewer.

Remarks

Given a topicname, examples looks for sections starting with titles specified in SMCL containing the word Examples (or alternatively Example) within any help file corresponding to topicname. It will not be able to show material from older, pre-SMCL help files or examples given otherwise.

Examples

. examples regress . examples reg

. examples normden()

Author

Nicholas J. Cox, University of Durham, U.K. n.j.cox@durham.ac.uk

Acknowledgments

Ken Higbee gave valuable help on aliases. Clive Nicholas pointed towards a bug. Roger Harbord identified a bug and fixed it.

Also see

On-line: help for help; smcl