Instructions

This section includes the following:

"Index to the RATS Instructions" provides a list of general groups of instructions by topic.

This is followed by separate pages for each of those general groups, with a list of the covered instructions with a short description and a link to the detail on that instruction.

Finally, a set of pages in alphabetical order with the detailed descriptions of the instructions. The description of each instruction begins with the basic syntax of the instruction, including its full name, the names we use for the parameters (if any), and the syntax for any supplementary cards, text cards, or data cards.

Several instructions have more than one possible syntax depending on the options used or the context of the instruction. For example, the description of CALENDAR shows the ten possible forms of the instruction.

Throughout this, we use the following conventions:

Instruction Names	are always in bold Courier font. For example BOXJENK, DATA
Parameter names	are always in italicized Courier font, generally lower case. For example, start, end, series
Option names	are always in (non-bold) Courier font (such as DATES and ORGANIZATION)

For instructions which have one or more options, we include an Options section which describes them in detail. Here, each option appears initially in bold type for clarity. We use the following conventions for describing options:

Switch Options

are listed in a form such as [dates]/nodates. The brackets indicate the default setting of the option.

Choice Options

each of the possible choices is listed after the option name, with brackets around the default choice. For example: organization=[rows]/columns.

Value Options

are presented like missing=missing value code. We put a description of the value in italics, similar to instruction parameters. Further discussions of this value will use the same phrase, again in Courier italics.

If a value option has a default value, it appears in bold type, enclosed in brackets. For example,

cvcrit=convergence criterion for \(\rho\) [.0001]