R devel - Nov 2014 - Changing style for the Sweave vignettes

As a user, I am always annoyed beyond measure that Sweave vignettes
precede the code by a command line prompt. It makes running examples
by simple copying of the commands from the vignette to the console a
pain. I know the idea is that it is clear what is the command, and
what is the output, but I'd rather precede the output with some kind
of marking.

Is there any other solution possible / allowed in vignettes? I would
much prefer to make my vignettes easier to use for people like me.

Kind regards,

j.

-- 
-------- January Weiner --------------------------------------

Not sure if this is the right list for your question, but

options("prompt"="")

should do it.

Regards
S?ren

|-----Original Message-----
|From: r-devel-bounces at r-project.org [mailto:r-devel-bounces at r-
|project.org] On Behalf Of January Weiner
|Sent: 13. november 2014 12:10
|To: r-devel
|Subject: [Rd] Changing style for the Sweave vignettes
|
|As a user, I am always annoyed beyond measure that Sweave vignettes
|precede the code by a command line prompt. It makes running examples by
|simple copying of the commands from the vignette to the console a pain. I
|know the idea is that it is clear what is the command, and what is the
|output, but I'd rather precede the output with some kind of marking.
|
|Is there any other solution possible / allowed in vignettes? I would much
|prefer to make my vignettes easier to use for people like me.
|
|Kind regards,
|
|j.
|
|--
|-------- January Weiner --------------------------------------
|
|______________________________________________
|R-devel at r-project.org mailing list
|https://stat.ethz.ch/mailman/listinfo/r-devel

On 11/13/2014 05:09 AM, January Weiner wrote:
> As a user, I am always annoyed beyond measure that Sweave vignettes
> precede the code by a command line prompt. It makes running examples
> by simple copying of the commands from the vignette to the console a
> pain. I know the idea is that it is clear what is the command, and
> what is the output, but I'd rather precede the output with some kind
> of marking.
>
> Is there any other solution possible / allowed in vignettes? I would
> much prefer to make my vignettes easier to use for people like me.
I agree with S?ren that this is not the right list, but to complete the 
thread...

See the examples in

?vignette

start just above

## Now let us have a closer look at the code

All vignette's are compiled.  You can trivially extract all the code 
used for any vignette in R, including any code not displayed in the text 
and hidden from the user, from within R, or saved out to an editor so 
you can source it line by line from Rstudio (or vim or emacs or...). 
That's the whole point.

Regards,

Brian

-- 
Brian G. Peterson
http://braverock.com/brian/
Ph: 773-459-4973
IM: bgpbraverock

On 11/13/2014 03:09 AM, January Weiner wrote:
> As a user, I am always annoyed beyond measure that Sweave vignettes
> precede the code by a command line prompt. It makes running examples
> by simple copying of the commands from the vignette to the console a
> pain. I know the idea is that it is clear what is the command, and
> what is the output, but I'd rather precede the output with some kind
> of marking.
>
> Is there any other solution possible / allowed in vignettes? I would
> much prefer to make my vignettes easier to use for people like me.
Vignettes do not need to be generated by Sweave and to pdf documents. My current
favorite (e.g., recent course material at 
http://bioconductor.org/help/course-materials/ which uses styling from the 
BiocStyle package 
http://bioconductor.org/packages/release/bioc/html/BiocStyle.html) uses the 
knitr package (see http://yihui.name/knitr/) to produce HTML vignettes (knitr 
will also process Rnw files to pdf with perhaps more appealing styling, see, 
e.g.,  http://bit.ly/117OLVl for an example of PDF output).

The mechanics are discussed in Writing R Extensions
(RShowDoc('R-exts')),
section 1.4.2 Non-Sweave vignettes. There are three steps involved: specifying a
\VignetteEngine in the vignette itself, specifying VignetteBuilder: field in the
DESCRIPTION file, and including the package providing the engine (knitr, in my 
case) in the Suggests: field of the DESCRIPTION file.

Brian mentioned processing the vignette to it's underlying code; see 
?browseVignettes and ?vignette for installed packages, and ?Stangle in R and R 
CMD Stangle for extracting the R code from stand-alone vignettes to .R files.

Martin Morgan
>
> Kind regards,
>
> j.
>

-- 
Computational Biology / Fred Hutchinson Cancer Research Center
1100 Fairview Ave. N.
PO Box 19024 Seattle, WA 98109

Location: Arnold Building M1 B861
Phone: (206) 667-2793