Hi,
I'm putting together an R package. In explaining how it works (in the
Rd files), I want to refer to another package. The other package is not
used anywhere in the actual code nor in the examples. So, there is no
reason to include the other package in the Depends, Suggests, or Imports
lines of the DESCRIPTION file. People will be able to use my package
without actually installing the other package.
However, "R CMD check" warns about "Missing link(s)" when it
is checking
the cross references in the Rd files.
What is the preferred way to make this warning go away?
Thanks in advance,
Kevin
On Thu, 27 Jan 2011, Kevin R. Coombes wrote:> Hi, > > I'm putting together an R package. In explaining how it works (in the Rd > files), I want to refer to another package. The other package is not used > anywhere in the actual code nor in the examples. So, there is no reason to > include the other package in the Depends, Suggests, or Imports lines of the > DESCRIPTION file. People will be able to use my package without actually > installing the other package. > > However, "R CMD check" warns about "Missing link(s)" when it is checking the > cross references in the Rd files. > > What is the preferred way to make this warning go away?Follow the 'Writing R Extensions' manual. There is a 3-item bullet point in ?1.1.1 following 'The general rules are' and your claims contradict the third point.> > Thanks in advance, > Kevin > > ______________________________________________ > R-devel at r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-devel >-- 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
If you add the other package to Suggests, what problems do you see? Adding the other package to Suggests seems most appropriate, your use case seems very similar to packages discussed in a vignette. Steven McKinney ________________________________________ From: r-devel-bounces at r-project.org [r-devel-bounces at r-project.org] On Behalf Of Prof Brian Ripley [ripley at stats.ox.ac.uk] Sent: January 27, 2011 2:12 PM To: Kevin R. Coombes Cc: r-devel at r-project.org Subject: Re: [Rd] use of depends, suggests, etc On Thu, 27 Jan 2011, Kevin R. Coombes wrote:> Hi, > > I'm putting together an R package. In explaining how it works (in the Rd > files), I want to refer to another package. The other package is not used > anywhere in the actual code nor in the examples. So, there is no reason to > include the other package in the Depends, Suggests, or Imports lines of the > DESCRIPTION file. People will be able to use my package without actually > installing the other package. > > However, "R CMD check" warns about "Missing link(s)" when it is checking the > cross references in the Rd files. > > What is the preferred way to make this warning go away?Follow the 'Writing R Extensions' manual. There is a 3-item bullet point in ?1.1.1 following 'The general rules are' and your claims contradict the third point.> > Thanks in advance, > Kevin > > ______________________________________________ > R-devel at r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-devel >-- 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