From january.weiner at gmail.com  Thu Nov 13 17:10:23 2014
From: january.weiner at gmail.com (January Weiner)
Date: Thu, 13 Nov 2014 17:10:23 +0100
Subject: [Rd] Changing style for the Sweave vignettes
In-Reply-To: <5464C1AF.1000401@gmail.com>
References: <CA+A1kV4FSFtUMDPME0_MEMM_orCX+U9jgUZ9m1_rT0-ftRE4Fg@mail.gmail.com>
	<546497D7.50009@braverock.com>
	<CA+A1kV5CGck2ucp+sjb9U6vpB0WkEry8QCeVS6oMX6dzOd_1Xg@mail.gmail.com>
	<5464C1AF.1000401@gmail.com>
Message-ID: <CA+A1kV5jtNnrQn2dNH8-OGBGNcqjMjkPY6OO0Bf+q2odkfWfmQ@mail.gmail.com>

Dear Paul and Martin,

thanks for the useful tips. I'll start with Paul's suggestion (getting
rid of these '+'-es will already be a boon!), and move from my old
Sweave vignettes when possible.

Thank you!
j.

On 13 November 2014 15:35, Paul Gilbert <pgilbert902 at gmail.com> wrote:
> You might also consider starting your vignettes with
>
> \begin{Scode}{echo=FALSE,results=hide}
>  options(continue="  ")
> \end{Scode}
>
> Then you get one prompt but it is still easy to cut and paste. This has been
> in many of my packages for many years, so I think it would be fair to assume
> it is acceptable.
>
> Paul
>
>
> On 11/13/2014 06:56 AM, January Weiner wrote:
>>
>> Thank you, S?ren and Brian for your answers.
>>
>> Whether this is the right list -- well, I think it is, since I am
>> developing a package and would like to create a vignette which is
>> useful and convenient for my users. I know how to extract the vignette
>> code. However, most of my users don't.  Or if they do, they do not
>> bother, but copy the examples from the PDF while they are reading it.
>> At least that is my observation.
>>
>> I'm sorry that my e-mail was unclear -- I started my e-mail with "as a
>> user, ...", but I did mention that it is my vignettes that I am
>> concerned with.
>>
>> options(prompt=...) is an idea, though I'm still not sure as to the
>> second part of my question - whether a vignette without a command
>> prompt is acceptable in a package or not.
>>
>> Kind regards,
>>
>> j.
>>
>>
>> On 13 November 2014 12:36, Brian G. Peterson <brian at braverock.com> wrote:
>>>
>>> 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
>>>
>>>
>>> ______________________________________________
>>> R-devel at r-project.org mailing list
>>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>
>>
>>
>>
>



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



[Rd] Changing style for the Sweave vignettes
January Weiner