From ripley at stats.ox.ac.uk  Mon Jun  4 21:42:57 2007
From: ripley at stats.ox.ac.uk (Prof Brian Ripley)
Date: Mon, 4 Jun 2007 20:42:57 +0100 (BST)
Subject: [Rd] HTML vignette browser
In-Reply-To: <eb555e660706041125n57bb6e6dq9b251975c5f7e7de@mail.gmail.com>
References: <eb555e660706011622t4a0538a8obda2b8c4d87d49d0@mail.gmail.com>
	<18020.13934.289824.556395@lxh5.stat.uni-muenchen.de>
	<m2zm3f3b4i.fsf@ziti.local>
	<eb555e660706041125n57bb6e6dq9b251975c5f7e7de@mail.gmail.com>
Message-ID: <Pine.LNX.4.64.0706042040200.19228@auk.stats>

Folks,

I think this is a nice idea (and not very different to somethign I have 
bene playing with), but with lots of CHARSXP changes pending I'd 
like to come back to it next week or so.

Sorry, Deepayan, you've happened to hit a very busy stage in R 
development.

Brian

On Mon, 4 Jun 2007, Deepayan Sarkar wrote:

> On 6/4/07, Seth Falcon <sfalcon at fhcrc.org> wrote:
>> Friedrich Leisch <friedrich.leisch at stat.uni-muenchen.de> writes:
>>> Looks good to me, and certainly something worth being added to R.
>>>
>>> 2 quick (related) comments:
>>>
>>> 1) I am not sure if we want to include links to the Latex-Sources by
>>>    default, those might confuse unsuspecting novices a lot. Perhaps
>>>    make those optional using an argument to browseVignettes(), which
>>>    is FALSE by default?
>>
>> I agree that the Rnw could confuse folks.  But I'm not sure it needs
>> to be hidden or turned off by default...  If the .R file was also
>> included then it would be less confusing I suspect as the curious
>> could deduce what Rnw is about by triangulation.
>>
>>> 2) Instead links to .Rnw files we may want to include links to the R
>>>    code -> should we R CMD INSTALL a tangled version of each vignette
>>>    such that we can link to it? Of course it is redundant information
>>>    given the .Rnw, but we also have the help pages in several formats
>>>    ready.
>>
>> Including, by default, links to the tangled .R code seems like a
>> really nice idea.  I think a lot of users who find vignettes don't
>> realize that all of the code used to generate the entire document is
>> available to them -- I just had a question from someone who wanted to
>> know how to make a plot that appeared in a vignette, for example.
>
> I agree that having a Stangled .R file would be a great idea (among
> other things, it would have the complete code, which many PDFs will
> not).
>
> I don't have a strong opinion either way about linking to the .Rnw
> file. It should definitely be there if the PDF file is absent (e.g.
> for grid, and other packages installed with --no-vignettes, which I
> always do for local installation). Maybe we can keep them, but change
> the name to something more scary than "source", e.g. "LaTeX/Noweb
> source".
>
> -Deepayan
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>

-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595



[Rd] HTML vignette browser
Prof Brian Ripley