Re: [Rd] Link to pdf documentation from other package ?

From: <ml-it-r-devel_at_epigenomics.com>
Date: Wed, 18 Nov 2009 14:01:17 +0100

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) ?
>>>
>>>   
>>
>> There's no optional text in the \url{} tag, but you could embed it in
>> an \ifelse tag, e.g.
>>
>> \ifelse{html}{\url{ ....  }}{ [open pdf ...] }
>>
>> might work.  Using the \ifelse tag will make your package depend on R
>> >= 2.10.0.
>>
>> Duncan Murdoch
>>>   

> Another thought: the link only works, if the two packages are installed
> in the same library, doesn't it ? Would there be a way to make it work
> independently of this restriction ?

you could use the Sweave like macro to compute the path inside the Rd environments

\Sexpr{file.path(system.file(package="AlgDesign", "doc"), "AlgDesign.pdf")}

described in 'Writing R extensions' 2.11 <http://stat.ethz.ch/R-manual/R-patched/doc/manual/R-exts.html#Dynamic-pages>

> Regards, Ulrike
>
> ______________________________________________
> R-devel_at_r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>

-- 
Matthias Burger                     Project Manager/ Biostatistician
Epigenomics AG    Kleine Praesidentenstr. 1    10178 Berlin, Germany
phone:+49-30-24345-0                            fax:+49-30-24345-555
http://www.epigenomics.com           matthias.burger@epigenomics.com
--
Epigenomics AG Berlin           Amtsgericht Charlottenburg HRB 75861
Vorstand:                           Geert Nygaard (CEO/Vorsitzender)
                                            Oliver Schacht PhD (CFO)
Aufsichtsrat:   Prof. Dr. Dr. hc. Rolf Krebs (Chairman/Vorsitzender)

______________________________________________
R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Received on Wed 18 Nov 2009 - 13:05:18 GMT

This archive was generated by hypermail 2.2.0 : Wed 18 Nov 2009 - 21:40:28 GMT