From Rainer at krugs.de Thu Sep 5 17:54:36 2013 From: Rainer at krugs.de (Rainer M Krug) Date: Thu, 05 Sep 2013 17:54:36 +0200 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? Message-ID: Hi I want to include some preformated text (ASCII art) in a function documentation using roxygen2. I found the #'' tag, but it does not seem to be working - is it included in roxygen2? Or are there any other approaches to include preformatted text in function documentations using roxygen2? If I have to use roxygen3 - how can I use it from ESS? Thanks, Rainer -- Rainer M. Krug, PhD (Conservation Ecology, SUN), MSc (Conservation Biology, UCT), Dipl. Phys. (Germany) Centre of Excellence for Invasion Biology Stellenbosch University South Africa Tel : +33 - (0)9 53 10 27 44 Cell: +33 - (0)6 85 62 59 98 Fax : +33 - (0)9 58 10 27 44 Fax (D): +49 - (0)3 21 21 25 22 44 email: Rainer at krugs.de Skype: RMkrug -------------- next part -------------- A non-text attachment was scrubbed... Name: not available Type: application/pgp-signature Size: 486 bytes Desc: not available URL: From h.wickham at gmail.com Fri Sep 6 23:53:16 2013 From: h.wickham at gmail.com (Hadley Wickham) Date: Fri, 6 Sep 2013 16:53:16 -0500 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: References: Message-ID: > I want to include some preformated text (ASCII art) in a function > documentation using roxygen2. I found the #'' tag, but it does not seem > to be working - is it included in roxygen2? Or are there any other > approaches to include preformatted text in function documentations using > roxygen2? Not that I'm aware of. > If I have to use roxygen3 - how can I use it from ESS? Just call roxygenise yourself? Hadley -- Chief Scientist, RStudio http://had.co.nz/ From spinuvit at gmail.com Sat Sep 7 01:20:11 2013 From: spinuvit at gmail.com (Vitalie Spinu) Date: Fri, 06 Sep 2013 16:20:11 -0700 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: (Hadley Wickham's message of "Fri, 6 Sep 2013 16:53:16 -0500") References: Message-ID: <87li39r104.fsf@gmail.com> >> Hadley Wickham >> on Fri, 6 Sep 2013 16:53:16 -0500 wrote: [...] >> If I have to use roxygen3 - how can I use it from ESS? > Just call roxygenise yourself? ESS support for roxygen concerns editing/preformating/updating/previewing roxygen blocks. All of it is on C-c C-o keymap. To actually build your docs you need, indeed, to call roxygenise yourself. Vitalie From Rainer at krugs.de Mon Sep 9 09:10:29 2013 From: Rainer at krugs.de (Rainer M Krug) Date: Mon, 09 Sep 2013 09:10:29 +0200 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: (Hadley Wickham's message of "Fri, 6 Sep 2013 16:53:16 -0500") References: Message-ID: Hadley Wickham writes: >> I want to include some preformated text (ASCII art) in a function >> documentation using roxygen2. I found the #'' tag, but it does not seem >> to be working - is it included in roxygen2? Or are there any other >> approaches to include preformatted text in function documentations using >> roxygen2? > > Not that I'm aware of. Thanks - I thought that much but wanted to be sure that I am not missing anything. > >> If I have to use roxygen3 - how can I use it from ESS? > > Just call roxygenise yourself? True - and I have to do it anyway. Thanks, Rainer > > Hadley -- Rainer M. Krug email: RMKruggmailcom From Rainer at krugs.de Mon Sep 9 09:13:00 2013 From: Rainer at krugs.de (Rainer M Krug) Date: Mon, 09 Sep 2013 09:13:00 +0200 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: <87li39r104.fsf@gmail.com> (Vitalie Spinu's message of "Fri, 06 Sep 2013 16:20:11 -0700") References: <87li39r104.fsf@gmail.com> Message-ID: Vitalie Spinu writes: > >> Hadley Wickham > >> on Fri, 6 Sep 2013 16:53:16 -0500 wrote: > > [...] > > > >> If I have to use roxygen3 - how can I use it from ESS? > > > Just call roxygenise yourself? > > ESS support for roxygen concerns > editing/preformating/updating/previewing roxygen blocks. All of it is on > C-c C-o keymap. > > To actually build your docs you need, indeed, to call roxygenise > yourself. Absolutely true - and I am doing this in my package anyway. So I can switch to roxygen3 easily. But is there a variable which specifu which roxygen (roxygen, roxygen2, roxygen3) will be used for previewing, so that the preview and the final result are consistent? Thanks, Rainer > > > Vitalie <#secure method=pgpmime mode=sign> -- Rainer M. Krug email: RMKruggmailcom From spinuvit at gmail.com Mon Sep 9 19:38:34 2013 From: spinuvit at gmail.com (Vitalie Spinu) Date: Mon, 09 Sep 2013 10:38:34 -0700 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: (Rainer M. Krug's message of "Mon, 09 Sep 2013 09:13:00 +0200") References: <87li39r104.fsf@gmail.com> Message-ID: <87ppshrj39.fsf@gmail.com> >> Rainer M Krug >> on Mon, 09 Sep 2013 09:13:00 +0200 wrote: [...] > But is there a variable which specifu which roxygen (roxygen, roxygen2, > roxygen3) will be used for previewing, so that the preview and the final > result are consistent? Ok, that is a good question. This roxygenN naming does complicate the stuff a bit. I have to look into the code, Henning (cced), can tell you better. Vitalie From brian at braverock.com Mon Sep 9 19:51:21 2013 From: brian at braverock.com (Brian G. Peterson) Date: Mon, 09 Sep 2013 12:51:21 -0500 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: <87ppshrj39.fsf@gmail.com> References: <87li39r104.fsf@gmail.com> <87ppshrj39.fsf@gmail.com> Message-ID: <522E0A99.4080206@braverock.com> On 09/09/2013 12:38 PM, Vitalie Spinu wrote: > > But is there a variable which specifu which roxygen (roxygen, roxygen2, > > roxygen3) will be used for previewing, so that the preview and the final > > result are consistent? > > Ok, that is a good question. This roxygenN naming does complicate the > stuff a bit. I have to look into the code, Henning (cced), can tell you > better. I'd prefer to not change the package name (again). I believe Hadley had indicated that he thought the code could be folded back into the roxygen2 package, not forked and renamed, the last time this was discussed. Versioning in DESCRIPTION works just fine. -- Brian G. Peterson http://braverock.com/brian/ Ph: 773-459-4973 IM: bgpbraverock From h.wickham at gmail.com Mon Sep 9 19:55:58 2013 From: h.wickham at gmail.com (Hadley Wickham) Date: Mon, 9 Sep 2013 12:55:58 -0500 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: <522E0A99.4080206@braverock.com> References: <87li39r104.fsf@gmail.com> <87ppshrj39.fsf@gmail.com> <522E0A99.4080206@braverock.com> Message-ID: >> > But is there a variable which specifu which roxygen (roxygen, >> roxygen2, >> > roxygen3) will be used for previewing, so that the preview and the >> final >> > result are consistent? >> >> Ok, that is a good question. This roxygenN naming does complicate the >> stuff a bit. I have to look into the code, Henning (cced), can tell you >> better. > > I'd prefer to not change the package name (again). I believe Hadley had > indicated that he thought the code could be folded back into the roxygen2 > package, not forked and renamed, the last time this was discussed. The big advantage (in the current situation), is that it's much easier to have both versions installed simultaneously. Hadley -- Chief Scientist, RStudio http://had.co.nz/ From spinuvit at gmail.com Mon Sep 9 20:15:51 2013 From: spinuvit at gmail.com (Vitalie Spinu) Date: Mon, 09 Sep 2013 11:15:51 -0700 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: (Hadley Wickham's message of "Mon, 9 Sep 2013 12:55:58 -0500") References: <87li39r104.fsf@gmail.com> <87ppshrj39.fsf@gmail.com> <522E0A99.4080206@braverock.com> Message-ID: <87li35rhd4.fsf@gmail.com> >> Hadley Wickham >> on Mon, 9 Sep 2013 12:55:58 -0500 wrote: [...] > The big advantage (in the current situation), is that it's much easier > to have both versions installed simultaneously. Yes, but you can name old-version as roxygen-old and whoever wants to use the old version can used that. This is uniformly better than giving new names to the packages. Would you mind naming roxygen3 simply roxygen? Vitalie From h.wickham at gmail.com Mon Sep 9 20:18:16 2013 From: h.wickham at gmail.com (Hadley Wickham) Date: Mon, 9 Sep 2013 13:18:16 -0500 Subject: [Roxygen-devel] \preformatted and #'' in roxygen2? In-Reply-To: <87li35rhd4.fsf@gmail.com> References: <87li39r104.fsf@gmail.com> <87ppshrj39.fsf@gmail.com> <522E0A99.4080206@braverock.com> <87li35rhd4.fsf@gmail.com> Message-ID: > > The big advantage (in the current situation), is that it's much easier > > to have both versions installed simultaneously. > > Yes, but you can name old-version as roxygen-old and whoever wants to > use the old version can used that. This is uniformly better than giving > new names to the packages. > > Would you mind naming roxygen3 simply roxygen? There is no way roxygen3 will become roxygen, but it will probably become roxygen2, once I've firmly decided that the roxygen3 will be backward compatible. In the mean time, there is no advantage to renaming the package, given that it works differently, and I have made no effort to make the API the same as roxygen2. Hadley -- Chief Scientist, RStudio http://had.co.nz/