Next: arimares() Up: Arima Macros Help File Previous: arima()   Contents

arimahelp()

Usage:
arimahelp(topic1 [, topic2 ...] [,usage:T] [,scrollback:T])
arimahelp(topic, subtopic:Subtopics), CHARACTER scalar or vector
  Subtopics
arimahelp(topic1:Subtopics1 [,topic2:Subtopics2 ...])
arimahelp(key:Key), CHARACTER scalar Key
arimahelp(index:T [,scrollback:T])



Keywords: general
arimahelp(Topic1 [, Topic2, ...]) prints help on topics Topic1, Topic2,
... related to macros in file arima.mac.  The help is taken from file
arima.mac.

arimahelp(Topic1 [, Topic2, ...] , usage:T) prints usage information
related to these macros.

arimahelp(index:T) or simply arimahelp() prints an index of the topics
available using arimahelp().

arimahelp(Topic, subtopic:Subtopic), where Subtopic is a CHARACTER
scalar or vector, prints subtopics of topic Topic.  With subtopic:"?", a
list of subtopics is printed.

arimahelp(Topic1:Subtopics1 [,Topic2:Subtopics2], ...), where Suptopics1
and Subtopics2 are CHARACTER scalars or vectors, prints the specified
subtopics.  You can't use any other keywords with this usage.

In all the first 4 of these usages, you can also include help() keyword
phrase 'scrollback:T' as an argument to arimahelp().  In windowed
versions, this directs the output/command window will be automatically
scrolled back to the start of the help output.

arimahelp(key:key) where key is a quoted string or CHARACTER scalar
lists all topics cross referenced under Key.  arimahelp(key:"?") prints
a list of available cross reference keys for topics in the file.

arimahelp() is implemented as a predefined macro.

See help() for information on direct use of help() to retrieve
information from arima.mac.


Gary Oehlert 2003-01-15