[R-pkg-devel] Fwd: R CMD check and strange ## Not run strings

Tomas Hudik xhudik at gmail.com
Wed Dec 20 15:53:21 CET 2017

thank you guys for fast replies - good ideas and points! They completely
makes sense.

@Georgi - yes, the rendering is the issue. I personally find \dontrun{}
better understandable then rendered ## Not Run.
Maybe even better would be to have rendered "r-markdown kind" where you can
click on a small triangle icon(
http://rmarkdown.rstudio.com/r_notebooks.html#executing_code) and the
example would run for you. So user can:
1. run the code when he wants
2. wont have to think whether ## Not run is a comment or some kind of
escape or special command (my case 3 days before)

I understand "r-markdown kind" rendering would be possible in GUI apps only
(Rstudio). The question is how to do it on R core (command line) level.

what do you think?

best, Tomas

On Tue, Dec 19, 2017 at 11:20 PM, Georgi Boshnakov <
georgi.boshnakov at manchester.ac.uk> wrote:

> Sure, but \dontrun's function is to prevent the R tools from running the
> enclosed code.
> How it is rendered is a completely separate matter.  The code in \dontrun
> is  not required to be executable (or even valid R code), so surely there
> should be some sort of visual clue in the rendered page. I don't argue
> whether it should be the one shown now or should be left entirely to the
> package author, although the current one seems reasonable to me.
> Georgi
> -----Original Message-----
> From: Hadley Wickham [mailto:h.wickham at gmail.com]
> Sent: 19 December 2017 19:22
> To: Georgi Boshnakov
> Cc: Tomas Hudik; r-package-devel at r-project.org
> Subject: Re: [R-pkg-devel] Fwd: R CMD check and strange ## Not run strings
> > This actually is not about Rd format. Indeed, you are using   'roxygen'
> syntax.
> This is unrelated to roxygen. \dontrun{} is Rd formatting.
> Hadley
> --
> http://hadley.nz

	[[alternative HTML version deleted]]

More information about the R-package-devel mailing list