| fun2 {topichelp} | R Documentation |
This file documents fun2, which is already documented in fun1.
fun2(x, ...) fun3(x, ...)
x |
An object. |
... |
Extra arguments. |
The existence of this help page should trigger a WARNING during
R CMD check.
Other than that, this file checks for possible problems in how within-package links are handled, as well as potential problems with special characters and case.
The usual forms of a within-package link to a topic foo are
\link{foo}
\link[=foo]{link-text}
These are meant to behave like help(foo), presumably with
preference to the current package, although this is maybe not clearly
documented. Links to a file by name are not supported. The following
are examples of the first form:
\link{fun1}: fun1 is a topic in both
fun2.Rd and funs.Rd
\link{fun2}: fun2 is a topic only in funs.Rd
\link{fun3}: fun3 is a topic only in
fun2.Rd (this file)
\link{funs}: funs is a not a topic, but
a file, so the link should be invalid. It may go to the same topic
in another package (e.g., dplyr), if available, even if that
package is not loaded.
\link{fit}: fit should go to either
generics::fit or parsnip::fit; if both packages are
loaded, it should give a choice.
\link{foobar}: foobar really shouldn't
go anywhere.
For the last two examples, the resolution to a topic in another package is attempted at package installation time for static HTML, so this is one situation where the static behaviour cannot easily be changed to match the dynamic behaviour.
Corresponding examples of the second form are:
\link[=fun1]{link-text}: link-text
\link[=fun2]{link-text}: link-text
\link[=fun3]{link-text}: link-text
\link[=funs]{link-text}: link-text
\link[=fit]{link-text}: link-text
Math operator aliases in particular could lead to weird filenames. Here are some examples:
Filenames on Windows / Mac (?) are not case-sensitive; this could lead to problems particularly with aliases that differ by case.
These links to grid have the wrong case: rectgrob;
GRID.RECT.
The following pairs of aliases are both valid, but are in different files.
Explicit package links: FUN4; fun4.
Implicit package links: FUN4; fun4.