[Rd] Roxygen

2012-03-03 Thread Serdar
Hi, I'm writing documentation using Roxygen and writing in Swedish. But I can't use åäö for instance and I haven't found any encoding option in the R-manual. Is there any one that can help me? Regards Serdar __ R-devel@r-project.org mailing list ht

Re: [Rd] Roxygen: @example tag does not work for me

2010-11-04 Thread Janko Thyson
> -Ursprüngliche Nachricht- > Von: h.wick...@gmail.com [mailto:h.wick...@gmail.com] Im Auftrag von > Hadley Wickham > Gesendet: Donnerstag, 4. November 2010 19:00 > An: Janko Thyson > Cc: r-de...@r-project. org > Betreff: Re: [Rd] Roxygen: @example tag does not work fo

Re: [Rd] Roxygen: @example tag does not work for me

2010-11-04 Thread Hadley Wickham
> I thought that @example would take the R code in "tests/foo.R" (this file > also exists) and append it to the .Rd-file. However, there is no > \examples{...} section in my roxygen-processed .Rd-file after running > roxygenize(). It just seems as if @example is just neglected. Should I put > the f

Re: [Rd] [Roxygen-devel] Roxygen: @example tag does not work for me

2010-11-04 Thread Janko Thyson
> -Ursprüngliche Nachricht- > Von: Vinh Nguyen [mailto:vqngu...@uci.edu] > Gesendet: Donnerstag, 4. November 2010 17:15 > An: Janko Thyson > Cc: r-de...@r-project. org > Betreff: Re: [Roxygen-devel] Roxygen: @example tag does not work for me > > I didn't know @example path/to/file.R was av

Re: [Rd] [Roxygen-devel] Roxygen: @example tag does not work for me

2010-11-04 Thread Vinh Nguyen
I didn't know @example path/to/file.R was available until you mentioned the UseR! 2010 presentation. If that's the case, I'm going to guess that you have to specify use.Rd2=TRUE in roxygenize(), as I've found most of the new features mentioned in that presentation to require it. On Thu, Nov 4, 2

Re: [Rd] [Roxygen-devel] Roxygen: @example tag does not work for me

2010-11-04 Thread Janko Thyson
> -Ursprüngliche Nachricht- > Von: roxygen-devel-boun...@lists.r-forge.r-project.org [mailto:roxygen- > devel-boun...@lists.r-forge.r-project.org] Im Auftrag von Vinh Nguyen > Gesendet: Donnerstag, 4. November 2010 04:04 > An: roxygen-de...@r-forge.wu-wien.ac.at > Betreff: Re: [Roxygen-dev

Re: [Rd] Roxygen: @example tag does not work for me

2010-11-04 Thread Janko Thyson
> -Ursprüngliche Nachricht- > Von: baptiste auguie [mailto:baptiste.aug...@googlemail.com] > Gesendet: Donnerstag, 4. November 2010 07:43 > An: Janko Thyson > Cc: r-de...@r-project. org > Betreff: Re: [Rd] Roxygen: @example tag does not work for me > > Hi, >

Re: [Rd] Roxygen: @example tag does not work for me

2010-11-03 Thread baptiste auguie
Hi, I think you could achieve this using the brew package. Define a function that reads your external example file, and have brew insert the resulting string in your script, which can then be processed by roxygen. I'm curious to hear other suggestions, but I doubt it could work out-of-the-box lik

[Rd] Roxygen: @example tag does not work for me

2010-11-03 Thread Janko Thyson
Dear list, somehow I can't get the Roxygen tag "@example" to work for me. My "Roxygen-Header" of a script containing, say, a function looks like this: #' My header #' #' My description #' #' @param a Blabla. #' @param b Blabla. #' @return \code{TRUE}. #' @callGraphPrimitives

[Rd] Roxygen: question regarding 'use.Rd2' and creation of DESCRIPTION

2010-09-15 Thread Janko Thyson
Dear List, I ran into the following two problems while using the package 'roxygen': QUESTION 1 I split the relevant R-Code for my package into the following scripts: classes.R (S4), functions.R ('standard' functions), generics.R (S4), methods.R (S4). Function package.skeleton() generates Rd-files

Re: [Rd] Roxygen

2008-03-24 Thread Manuel . Eugster
Hey Peter, sorry for the delay, I was on easter holiday. > Would it suffice, by the way, to source() a file and introspect upon > its objects with ls(), formals(), typeof(), mode(), and the like; or > should we formalize, say, a BNF and write the accompanying automaton? I agree with Duncan and H

Re: [Rd] Roxygen

2008-03-21 Thread hadley wickham
On Fri, Mar 21, 2008 at 11:36 AM, Duncan Murdoch <[EMAIL PROTECTED]> wrote: > On 21/03/2008 2:09 AM, Peter Danenberg wrote: > >> No, we want a solution in R. > > > > Would it suffice, by the way, to source() a file and introspect upon > > its objects with ls(), formals(), typeof(), mode(), and

Re: [Rd] Roxygen

2008-03-21 Thread Peter Danenberg
> parse() currently does nothing with comments, but it does tell you > where each parsed expression came from . . . That's exactly what I was looking for, Duncan; thanks. In fact, I used parse() recently to write a telnet frontend to R. __ R-devel@r-pro

Re: [Rd] Roxygen

2008-03-21 Thread Duncan Murdoch
On 21/03/2008 2:09 AM, Peter Danenberg wrote: >> No, we want a solution in R. > > Would it suffice, by the way, to source() a file and introspect upon > its objects with ls(), formals(), typeof(), mode(), and the like; or > should we formalize, say, a BNF and write the accompanying automaton? I d

Re: [Rd] Roxygen

2008-03-20 Thread Peter Danenberg
> No, we want a solution in R. Would it suffice, by the way, to source() a file and introspect upon its objects with ls(), formals(), typeof(), mode(), and the like; or should we formalize, say, a BNF and write the accompanying automaton? __ R-devel@r-p

Re: [Rd] Roxygen

2008-03-20 Thread Manuel . Eugster
>> It is desirable that these tags and their syntax and semantics be >> compatible with those used by Doxygen and Javadoc, but extended with >> tags important for R specific things. > > Doxygen, in particular, has some tags that are meaningless in R > (@category and @protocol come to mind); wouldn'

Re: [Rd] Roxygen

2008-03-19 Thread Peter Danenberg
> You might also want to look at the Rdoc setup in the R.oo package. Hmm; Rdoc seems thorough enough. What remains to be desired? __ R-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-devel

Re: [Rd] Roxygen

2008-03-19 Thread Peter Danenberg
> It is desirable that these tags and their syntax and semantics be > compatible with those used by Doxygen and Javadoc, but extended with > tags important for R specific things. Doxygen, in particular, has some tags that are meaningless in R (@category and @protocol come to mind); wouldn't it be

Re: [Rd] Roxygen

2008-03-19 Thread hadley wickham
On Wed, Mar 19, 2008 at 4:15 PM, Peter Danenberg <[EMAIL PROTECTED]> wrote: > > You should probably also survey existing attempts - I have written > > something with ruby that suggest some ideas. > > Fascinating, Hadley; do you have a link to the source, by any chance? It's completely local. I'

Re: [Rd] Roxygen

2008-03-19 Thread Manuel J. A. Eugster
Hey Peter, >> I do not see the Roclets as mini-parsers, but as small R programs >> working on the parse tree/list returned by one big parser/lexer. > > So I imagine that coming up with the intermediate parse-tree > representation would be part of the contract. Yes, sure. > What would you think

Re: [Rd] Roxygen

2008-03-19 Thread Kasper Daniel Hansen
You might also want to look at the Rdoc setup in the R.oo package. While my 30 secs glance at Roxygen suggests that it is a more flexible system, Rdoc always you to keep the help inside the function source file. Kasper On Mar 19, 2008, at 8:15 AM, Peter Danenberg wrote: >> You should proba

Re: [Rd] Roxygen

2008-03-19 Thread Peter Danenberg
> I do not see the Roclets as mini-parsers, but as small R programs > working on the parse tree/list returned by one big parser/lexer. So I imagine that coming up with the intermediate parse-tree representation would be part of the contract. What would you think, by the way, of writing the parser

Re: [Rd] Roxygen

2008-03-19 Thread Peter Danenberg
> You should probably also survey existing attempts - I have written > something with ruby that suggest some ideas. Fascinating, Hadley; do you have a link to the source, by any chance? I imagine doing it in Scheme, Ruby or any language, for that matter, where creating DSLs is cheap; would be a j

Re: [Rd] Roxygen

2008-03-18 Thread hadley wickham
On Mon, Mar 17, 2008 at 11:56 PM, Peter Danenberg <[EMAIL PROTECTED]> wrote: > Is this the appropriate place for GSoC conversations? > > If I understand the proposal correctly, there should be a lexer > (written in R) that exposes an API; that API would be used by > segregated mini-parsers (Rocl

Re: [Rd] Roxygen

2008-03-18 Thread Manuel J. A. Eugster
Hey Peter, > If I understand the proposal correctly, there should be a lexer > (written in R) that exposes an API; that API would be used by > segregated mini-parsers (Roclets) which do the dirty work of Roxygen > -> {html, LaTeX, DocBook, ...} translation. you do not have to write the lexer/

[Rd] Roxygen

2008-03-17 Thread Peter Danenberg
Is this the appropriate place for GSoC conversations? If I understand the proposal correctly, there should be a lexer (written in R) that exposes an API; that API would be used by segregated mini-parsers (Roclets) which do the dirty work of Roxygen -> {html, LaTeX, DocBook, ...} translation. The