[R-pkg-devel] doc url to vignette

[Berry Boessenkool]

Thanks to all writers.

I'll sum up so people reading this later (e.g. me) find everything quickly.

TOPIC:

Link from Rd manuals to other vignettes and documentation via URL.



You can now reference to a vignette in another package (thanks, Uwe!) e.g.:

\url{https://cran.r-project.org/package=roxygen2/vignettes/rd.html}


If the vignette is in your own package, you can use the relative link that will also work off-line.
> To link from vignette1.html to vignette2.html,
> use URL "vignette2.html".  They'll be installed in the same directory


You should not use bit.ly links etc to circumvent CRAN checks.

If all else fails, add a note to the submission comment and hope the CRAN team accepts it.


Regards,
Berry

-------------------------------------





________________________________
From: Uwe Ligges <ligges at statistik.tu-dortmund.de>
Sent: Wednesday, September 21, 2016 3:00 PM
To: Duncan Murdoch; S Ellison; Berry Boessenkool; R package devel
Subject: Re: [R-pkg-devel] doc url to vignette

Update:

The https://cran.r-project.org/package=NAME/.... syntax works now and is
accepted.

Best,
Uwe Ligges



On 21.09.2016 14:20, Duncan Murdoch wrote:
> On 21/09/2016 7:57 AM, S Ellison wrote:
>> > How can I link to a certain page on CRAN without getting flagged for
>> non-
>> > canonical CRAN URL forms?
>>
>> In the interests of avoiding something that may change in future if
>> CRAN is restructured, would it be sufficient to include the link to
>> the vignette on the project home page you put in the DESCRIPTION file
>> URL?
>>
>> Or perhaps <heresy>you could sidestep cran URL checking by using a
>> bit.ly link pointed at your vignette, or similar redirect</heresy>...
>> that might even be easier to maintain if you move your vignette.
>
> In other words, try to mislead CRAN.  If you are caught doing that, you
> won't get much sympathy in the future.
>
> Why not just link to the copy of the vignette that is distributed with
> the package?  That will work even if your Internet connection doesn't.
> Just use a relative URL.  To link from vignette1.html to vignette2.html,
> use URL "vignette2.html".  They'll be installed in the same directory
> when the package is installed, so the relative link will work.
>
> Duncan Murdoch
>
> ______________________________________________


How can I link to a certain page on CRAN without getting flagged for non-canonical CRAN URL forms?
I currently use \url{https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html}

Found the following (possibly) invalid URLs:
  URL: https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html
    From: man/createDoc.Rd
    Status: 200
    Message: OK
    CRAN URL not in canonical form

  The canonical URL of the CRAN page for a package is
    https://CRAN.R-project.org/package=pkgname

Thanks ahead,

Berry

> R-package-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel

	[[alternative HTML version deleted]]