[R-pkg-devel] browseURL in examples

Mark van der Loo mark.vanderloo at gmail.com
Tue Aug 18 13:57:50 CEST 2015


Berry,

why not use

\href{[your link]}{[link text]}

in the documentation details[1]?

Best,
Mark
[1] https://cran.r-project.org/doc/manuals/R-exts.html#Marking-text



Op di 18 aug. 2015 om 13:21 schreef Duncan Murdoch <murdoch.duncan at gmail.com
>:

> On 18/08/2015 6:12 AM, Berry Boessenkool wrote:
> > Hi all,
> >
> > In the CRAN package policies [1], it says
> >
> > "Packages should not start external software (such as PDF viewers or
> > browsers) during examples or tests unless that specific instance of
> > the software is explicitly closed afterwards."
> >
> > If I want to refer to a website with browseURL in the examples,
> > what's the most elegant way to do it?
> >
> > \dontrun --> obtrusive "## not run" parts, confuse new R-users
> > # browseURL("www.link.html") --> user must uncomment things
>
> Using "if (interactive()) browseURL(...)" is a reasonable way.
>
> Duncan Murdoch
>
> >
> >
> > Or do you think links should only be used in Vignettes / References
> section?
> >
> > In this case, it's a reference to a statistical method,
> > and yes, I slightly feel like I'm misusing the examples section.
> > But I think that's where most people explore function usage...
> >
> >
> > Thanks for any ideas and thoughts,
> > Berry
> >
> > [1]
> > https://cran.r-project.org/web/packages/policies.html
> >
> >
> >       [[alternative HTML version deleted]]
> >
> > ______________________________________________
> > R-package-devel at r-project.org mailing list
> > https://stat.ethz.ch/mailman/listinfo/r-package-devel
> >
>
> ______________________________________________
> R-package-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>

	[[alternative HTML version deleted]]



More information about the R-package-devel mailing list