[Rd] Link to pdf documentation from other package ?

Duncan Murdoch murdoch at stats.uwo.ca
Tue Nov 24 16:31:50 CET 2009

On 11/24/2009 8:06 AM, Ulrike Groemping wrote:
> Duncan Murdoch-2 wrote:
>> On 11/18/2009 8:01 AM, ml-it-r-devel at epigenomics.com wrote:
>>> Ulrike Grömping wrote, On 11/18/09 13:28:
>>>> Duncan Murdoch schrieb:
>>>>> Ulrike Groemping wrote:
>>>>>> Duncan Murdoch-2 wrote:
>>>>>>> Ulrike Groemping wrote:
>>>>>>>> Dear developeRs,
>>>>>>>> I have not found anything recent about how to link to a vignette or
>>>>>>>> other
>>>>>>>> documentation from within Rd-files. Is this now possible with the
>>>>>>>> new
>>>>>>>> help
>>>>>>>> system ? For example, I would like to link to the file AlgDesign.pdf
>>>>>>>> provided within the doc directory of package AlgDesign.
>>>>>>> Yes, you can do it with a \url{} macro.  Use a relative link, acting
>>>>>>> as though the starting page is located in
>>>>>>> /library/AlgDesign/html/*.  So \url{../doc/AlgDesign.pdf}
>>>>>>> should work from the same package,
>>>>>>> \url{../../AlgDesign/doc/AlgDesign.pdf} from elsewhere.  Please let
>>>>>>> me know if this doesn't work, I haven't tested.
>>>>>>> Duncan Murdoch
>>>>>> Yes, this works, thanks! Is it also possible to display an
>>>>>> alternative text
>>>>>> instead of the URL itself, like with other links (e.g. show text
>>>>>> "Open pdf"
>>>>>> that operates the link) ?
>> ...
>> Within the dynamic help, you're also restricted in what files you can 
>> link to:  they need to be help pages, or files in the doc directory of a 
>> package, or a few other special cases.
>> Duncan Murdoch
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
> Good that you mention this restriction, this makes me understand my new
> problem. With his new version of AlgDesign, Bob Wheeler has made the file
> AlgDesign.pdf into a vignette which is no longer located in the doc
> directory but now in inst/doc. A link to that file from within my
> documentation does not work any longer. Would it be possible to include the
> directory inst/doc into the special cases to which linking is permitted ?

When you install the package, the contents of inst/doc would normally be 
copied to the doc directory.  Can you expand on why that doesn't happen 
in your case?

Duncan Murdoch

More information about the R-devel mailing list