Bug 16397 - R CMD check warns about links to separate package's index
Summary: R CMD check warns about links to separate package's index
Status: UNCONFIRMED
Alias: None
Product: R
Classification: Unclassified
Component: Misc (show other bugs)
Version: R 3.2.0
Hardware: ix86 (32-bit) Windows 32-bit
: P5 minor
Assignee: R-core
URL:
Depends on:
Blocks:
 
Reported: 2015-05-25 22:10 UTC by Kevin Ushey
Modified: 2015-05-25 22:12 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Kevin Ushey 2015-05-25 22:10:21 UTC
My goal here is to allow for a link to a separate package's help index -- for example, the `stats` package's help index. This works:

    \link[stats:00Index]{Link to 'stats' package help index}

but R CMD check gives the warning:

    * checking Rd cross-references ... WARNING
Missing link or links in documentation object 'hello.Rd':
  '[stats:00Index]{This index}'
Comment 1 Kevin Ushey 2015-05-25 22:12:58 UTC
Sorry, additional comments got lost; in addition the text doesn't match in the original comment. Forgive the redundancy but I believe it's more 'polite' to submit a more full-fledged bug report as a second comment.

Given the line in a .Rd page:

    \link[stats:00Index]{stats help}

A link to the stats help index is properly generated, but R CMD check warns:

    * checking Rd cross-references ... WARNING
    Missing link or links in documentation object 'hello.Rd':
      '[stats:00Index]{stats help}'


I did not see any relevant text in R-exts (http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Cross_002dreferences); in case there is a different, proper method of linking to another package's help index.

Is this a bug in R CMD check, or is there an alternative method for linking to a package's help index?

I'm using R version 3.2.0 Patched (2015-04-26 r68264) -- "Full of Ingredients"

Thanks,
Kevin