[R] Documenting options specific to a package.

[rolf at math.unb.ca]

If one specifies new options in a package, using the options()
function, where does/should one document these new options?

E.g. suppose that I put the line

	options(melvin=42)

in a file zzz.R in the R directory of the package source, where the
package contains functions foo(), bar(), clyde(), and irving() which
all query options("melvin") and take some action based on the value
of ``melvin''.  The user can of course change the value of ``melvin''
from its default value by doing, e.g.

        options(melvin=99)

Are there any conventions or standards as to how and where the option
``melvin'' should be documented?  It seems somewhat redundant to
include docmentation about melvin in the help on all 4 of foo(),
bar(), clyde(), and irving().

Thanks for any insights.

                                cheers,

                                        Rolf Turner
                                        rolf at math.unb.ca