From pgilbert at bank-banque-canada.ca  Wed Feb  9 16:47:09 2005
From: pgilbert at bank-banque-canada.ca (Paul Gilbert)
Date: Wed Feb  9 16:48:47 2005
Subject: [Rd] link to an alias in another package
In-Reply-To: <Pine.LNX.4.61.0502081201160.25242@gannet.stats>
References: <4208243C.4080605@bank-banque-canada.ca>
	<Pine.LNX.4.61.0502080710390.14407@gannet.stats>
	<aq2h01p3rt6a97s7bq91lc4pdf3v77899q@4ax.com>
	<Pine.LNX.4.61.0502081201160.25242@gannet.stats>
Message-ID: <420A307D.5060702@bank-banque-canada.ca>


In summary
> In some documentation for a package I am working on I have
>
>    \code{\link[stats]{varimax}}
>    \code{\link[stats]{promax}}
>
> The link to varimax works, but not the one to promax. Promax is an 
> alias under \name{varimax}.  ...

    \code(\link[stats:varimax]{promax}}

works but will probably break if promax is ever moved to its own Rd 
file. (From the discussion there is probably not a better general solution.)

    \code(\link{promax}}

works because stats is always installed, but is not a general solution 
because I have other cases where the package may not be installed.

    \code(\link[stats:promax]{varimax}}

which might be another (but presumably mistaken) interpretation of the 
Writing R Extensions documentation

>   \link[pkg:bar]{foo} to link to the package pkg with topic (file?)
>   foo and bar respectively.

does not work and also displays "varimax" in the text (which is not what 
I want).

Paul Gilbert


[Rd] link to an alias in another package
Paul Gilbert