[Bioc-devel] BioC 3.7 Windows check warning "file link zz in package yy does not exist "

[Joris Meys]

On Wed, Apr 25, 2018 at 11:52 PM, Rahmatallah, Yasir <YRahmatallah at uams.edu>
wrote:

> Dear all,
>
> Build report show that many packages still have check warnings due to
> missing file links (cross referencing pages from other packages) under
> windows. The issue happens because there are different man pages for
> different operating systems. My package (GSAR) shows the same warning under
> Windows in the build report, although it locally passes R CMD build and R
> CMD check without warnings. Although not a perfect solution, substituting
> the linking in the .Rd file \code{\link[pkg:bar]{foo}} with
> \code{\link{foo}} or \code{\link[pkg]{foo}} was suggested in a recent
> discussion
> https://stat.ethz.ch/pipermail/bioc-devel/2018-April/013315.html


Actually, that is the correct solution. As per "Writing R Extensions",
\link[pkg]{name} searches for a html file with the name name.html in
package pkg. In a number of cases the name of the html help file is not the
same as the function you want to point to. For example, ppois and qpois etc
are discussed in a page called Poisson. Also in "Writing R Extensions" they
mention that if you want to use another name as a link, you should do
\link[pkg:name]{foo}. In our example: \link[stats:Poisson]{ppois}

https://cran.r-project.org/doc/manuals/R-exts.html#Cross_002dreferences

>
> I understood that although a check warning is produced (under Windows
> only), it will be accepted (considered as advice) and packages that
> currently show it will proceed to Bioc release. Is that correct? There are
> still many packages showing this warning in yesterday's report
> http://bioconductor.org/checkResults/3.7/bioc-LATEST/#show=warnings
>

As this is the case for even recommended packages like the survival
package, I don't see how this would be a reason to reject a package. But it
still makes sense to adapt your links in the way it is specified in the
official R manual.

Cheers
Joris

-- 
Joris Meys
Statistical consultant

Department of Data Analysis and Mathematical Modelling
Ghent University
Coupure Links 653, B-9000 Gent (Belgium)
<https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g>

tel: +32 (0)9 264 61 79
-----------
Biowiskundedagen 2017-2018
http://www.biowiskundedagen.ugent.be/

-------------------------------
Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php

	[[alternative HTML version deleted]]