[R] Attempt at package documentation on debian: link to "data.frame" broken

Prof Brian Ripley ripley at stats.ox.ac.uk
Mon Dec 3 13:35:25 CET 2007


On Mon, 3 Dec 2007, Johannes Graumann wrote:

> Prof Brian Ripley wrote:
>
>> So you are talking about the HTML conversion of your help (.Rd) file?
>> (Links appear in other versions too.)
>>
>> The HTML links are intended to be used via help.start(), not directly, and
>> I think you find it actually points to ../../base/html/data.frame.html,
>> which is correct for use from help.start.  (You are probably quoting your
>> browser's intepretation of a relative URL.)

> Yes. I'm actually using (the really nice) rkward, which calls the html-help
> pages upon "?<something>". May this be specific to that usage ... now that
> I'm looking deeper into this I find that rkward actually tells me:

No, it was R that warned you.  (It seem you have swapped the credit and 
blame in your message.)

> Using non-linked HTML file: style sheet and hyperlinks may be incorrect
> - which is what happens ... how to switch to "linked HTML file"?

It all works via help.start() (as I did say), at least in a reliable R 
front end.  Running help.start() is how you set this up.

>> Note what the documentation says:
>>
>>    There are two other forms of optional argument specified as
>>    \link[pkg]{foo} and \link[pkg:bar]{foo} to link to the package pkg, to
>>    files foo.html and bar.html respectively. These are rarely needed,
>>    perhaps to refer to not-yet-installed packages (but there the
>>    HTML help system  will resolve the link at run time) or in the normally
>>    undesirable event that more than one package offers help on a topic
>>    (in which case the present package has precedence so this is only
>>    needed to refer to other packages).
>>
>> So unless you define data.frame() in your package, you don't need this
>> form.

> I see. This was actually part of the desperate attempt to find a solution to
> this wrong link target issue. I'm using a plain "\link(data.frame)" now
> again.
>
> Thanks, Joh
>
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.
>

-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595



More information about the R-help mailing list