In "Writing R Extensions" (1.7.0 (2003-04-16). ISBN 3-901167-54-4)
under
the section "Writing R help files" and the subsection
"Cross-references"
the usage of \link is currently a little bit unclear:
"There are optional arguments specified as \link[pkg]{foo} and
\link[pkg:bar]{foo} to link to the package pkg with topic (file?) foo
and bar respectively."
I suggest the following update:
"There are optional arguments specified as \link[pkg]{label} and
\link[pkg:name]{label} to make a link to the help document for name in
package pkg where the link will get the label 'label', e.g.
\code{\link[base:Normal]{dnorm}}."
I tried to avoid using 'topic' because that is used in the description
of \alias{topic} and that is not what is linked to. 'name' is better
since \name{name} is what defines the name of the help document (and is
the base for the name of the files generated).
Cheers
Henrik Bengtsson
Dept. of Mathematical Statistics @ Centre for Mathematical Sciences
Lund Institute of Technology/Lund University, Sweden
(Sweden +2h UTC, Melbourne +10 UTC, Calif. -7h UTC)
+46 708 909208 (cell), +46 46 320 820 (home),
+1 (508) 464 6644 (global fax),
+46 46 2229611 (off), +46 46 2224623 (dept. fax)
h b @ m a t h s . l t h . s e, http://www.maths.lth.se/~hb/
