[Bioc-devel] Linking packages in man pages

[Sidharth Jain]

Makes sense for mclapply, I'll remove the links in the documentation.

What about `%<>%` from magrittr? From my recollection, it should also be
available on Windows machines.

Thanks,
Sid

On Mon, Jun 17, 2019 at 4:05 PM Martin Morgan <mtmorgan.bioc using gmail.com>
wrote:

> mclapply is not available or documented on Windows. I think the solution
> is actually to be vague, and replace \code{\link[parallel]{mclapply}}) with
> \code{\link{mclapply}} at
> https://github.com/sellerslab/gemini/blob/b1408bdce22df08d6950fee578eaac7665f54960/R/gemini_parallelization.R#L9
>
> Martin
>
> On 6/17/19, 3:52 PM, "Bioc-devel on behalf of Sidharth Jain" <
> bioc-devel-bounces using r-project.org on behalf of sidharthsjain using gmail.com>
> wrote:
>
>     Hello,
>
>     I have been getting the following warnings upon package building on
> tokay1:
>
>     Found the following significant warnings:
>       Rd warning:
> C:/Users/pkgbuild/AppData/Local/Temp/RtmpwTSgiX/R.INSTALLe1c5c6b6ce1/gemini/man/gemini_parallelization.Rd:14:
>     file link 'mclapply' in package 'parallel' does not exist and so has
>     been treated as a topic
>       Rd warning:
> C:/Users/pkgbuild/AppData/Local/Temp/RtmpwTSgiX/R.INSTALLe1c5c6b6ce1/gemini/man/reexports.Rd:14:
>     file link '%<>%' in package 'magrittr' does not exist and so has been
>     treated as a topic
>
>     It seems that the problem is coming from links in my documentation. I
>     import functions from both packages.
>
>     I included the following in a function's roxygen2 skeleton:
>     \code{\link[parallel]{mclapply}})
>
>     I also added:@importFrom parallel mclapply
>     @importFrom magrittr `%<>%`
>
>     How should I indicate that these packages should be installed? Is this
>     a problem with my package, or a problem with the installation/tokay1?
>
>     Thanks,
>     Sid
>
>         [[alternative HTML version deleted]]
>
>     _______________________________________________
>     Bioc-devel using r-project.org mailing list
>     https://stat.ethz.ch/mailman/listinfo/bioc-devel
>
>

	[[alternative HTML version deleted]]