[ESS] Roxygen: arbitrary sections (@section)

[Mathieu Basille]

Dear Martin,

Thanks for your answer.

Le 30/01/2012 16:49, Martin Maechler a écrit :
> The last part of the above does not prove anything: Of course an *.Rd file
> with a \section{..}{..} is correctly converted to text (or latex or html or ..).

Well, it did prove something: that I didn't quite understand the whole 
Roxygen stuff. I think you fixed it, thanks!

> That is all in R's     R CMD Rdconv ...
> and entirely unrelated to anything Emacs, ESS, or Roxygen.
>
> But your point is ... rightly so ... that the @section  Roxygen entry
> is not translated
> to *.Rd using R's current functionality,
> which builds on using the 'roxygen' package.
>
> I guess that it nowadays should start using the 'roxygen2' package instead
> (and let's hope that that does not require and load many more packages).
> OTOH, roxygen2 is not API compatible to 'roxygen', so just replacing
> it may not quite be sufficient.
> ...
>
> For the moment, and from my point:
>
> "patches are welcome"
> (the current source is available via  svn (subversion) or a web browser from
>   https://svn.r-project.org/ESS/trunk/lisp/
>   and yes, the patch *MUST* be against the current source (modulo 1--3 days)

Do I understand correctly that one should now use roxygen2, which requires 
the development version of ESS? And that current stable ESS (5.14) can not 
deal with roxygen2, but only roxygen?

I have basically no knowledge of Lisp programming, but please let me know 
if I can be of any help here. Shall I start using and testing ESS-dev with 
roxygen2? Is it possible to keep both ESS-stable and ESS-dev on the same 
computer?

Sorry for the many (and probably dumb) questions, I feel pretty useless here...

Best,
Mathieu.


> Martin
>
>
>> Is there anything I can do to be able to use @section in Roxygen
>> documentation using Emacs?
>>
>> Note: I use ESS 5.14 with Emacs 23.2.1 under Debian Stable, with R 2.14.1
>> and roxygen package for R 0.1-3.
>>
>> Sincerely,
>> Mathieu Basille.
>>
>>
>> [1] http://ess.r-project.org/Manual/ess.html#Roxygen
>>
>> [2] http://roxygen.org/roxygen2-manual.pdf
>>
>> --
>>
>> ~$ whoami
>> Mathieu Basille, Post-Doc
>>
>> ~$ locate
>> Laboratoire d'Écologie Comportementale et de Conservation de la Faune
>> + Centre d'Étude de la Forêt
>> Département de Biologie
>> Université Laval, Québec
>>
>> ~$ info
>> http://ase-research.org/basille
>>
>> ~$ fortune
>> ``If you can't win by reason, go for volume.''
>> Calvin, by Bill Watterson.
>>
>> ______________________________________________
>> ESS-help at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/ess-help
>>

-- 

~$ whoami
Mathieu Basille, Post-Doc

~$ locate
Laboratoire d'Écologie Comportementale et de Conservation de la Faune
+ Centre d'Étude de la Forêt
Département de Biologie
Université Laval, Québec

~$ info
http://ase-research.org/basille

~$ fortune
``If you can't win by reason, go for volume.''
Calvin, by Bill Watterson.