Re: [R-pkg-devel] creating a link to a vignette in a .Rd file

2018-11-20 Thread Hadley Wickham
> None of these solutions seem perfect to me. I think that my suggestion is the > most natural, but as you point out it won’t work in all contexts. Perhaps the > safest approach is to give the vignette() command in the text of the help > file, one of your suggestions. If you do that, and you

Re: [R-pkg-devel] creating a link to a vignette in a .Rd file

2018-11-20 Thread Fox, John
Dear Georgi, Thank you for this. None of these solutions seem perfect to me. I think that my suggestion is the most natural, but as you point out it won’t work in all contexts. Perhaps the safest approach is to give the vignette() command in the text of the help file, one of your

Re: [R-pkg-devel] creating a link to a vignette in a .Rd file

2018-11-20 Thread Georgi Boshnakov
It is somewhat problematic to make the link to the vignette fully portable. The solution with "../doc/..." may not work if the reference manual is read off the CRAN page of a package. For a CRAN package, an alternative is to link to the vignette on its CRAN page (if the vignette is already

Re: [R-pkg-devel] creating a link to a vignette in a .Rd file

2018-11-19 Thread Fox, John
Dear Hadley, You're right -- my approach was flawed and the document doesn't open even when the file URL is hard-coded in the .Rd file. With that hint, I found the following solution: \href{../doc/partial-residuals.pdf}{partial-residuals vignette} This works and passes package

Re: [R-pkg-devel] creating a link to a vignette in a .Rd file

2018-11-19 Thread Hadley Wickham
On Mon, Nov 19, 2018 at 4:49 PM Fox, John wrote: > > Dear r-package-devel list members, > > I'd like to create a link to a package vignette from a help file in the same > package, for example to the "partial-residuals" vignette in the effects > package from effect.Rd. I'm able to generate a URL