Previous: Getting Ready for the

Up: Adding Models and Methods

Next: Help File Template

Formatting Reference Manual Pages

One of the primary advantages of Zelig is that it fully documents the included models, in contrast to the programming-orientation of R documentation which is organized by function. Thus, we ask that Zelig contributors provide similar documentation, including the syntax and arguments passed to zelig(), the systematic and stochastic components to the model, the quantities of interest, the output values, and further information (including references). There are several ways to provide this information:

• If you have an existing package documented using the .Rd help format, help.zelig() will automatically search R-help in addition to Zelig help.
• If you have an existing package documented using on-line HTML files with static URLs (like Zelig or MatchIt), you need to provide a PACKAGE.url.tab file which is a two-column table containing the name of the function in the first column and the url in the second. (Even though the file extension is .url.tab, the file should be a tab- or space-delimited text file.) For example:

  command       http://gking.harvard.edu/zelig/docs/Main_Commands.html
  model         http://gking.harvard.edu/zelig/docs/Specific_Models.html
  

  If you wish to test to see if your .url.tab files works, simply place it in your R library/Zelig/data/ directory. (You do not need to reinstall Zelig to test your .url.tab file.)
• Preferred method: You may provide a L^ATEX2_e .tex file. This document uses the book style and supports commands from the following packages: graphicx, natbib, amsmath, amssymb, verbatim, epsf, and html. Because model pages are incorporated into this document using 1#1 include{}, you should make sure that your document compiles before submitting it. Please adhere to the following conventions for your model page:
  1. All mathematical formula should be typeset using the equation* and array, eqnarray*, or align environments. Please avoid displaymath. (It looks funny in html.)
  2. All commands or R objects should use the texttt environment.
  3. The model begins as a subsection of a larger document, and sections within the model page are of sub-subsection level.
  4. For stylistic consistency, please avoid using the description environment.

  Each L^ATEX model page should include the following elements. Let contrib specify the new model.