From mboxrd@z Thu Jan 1 00:00:00 1970 From: Erik Iverson Subject: Re: [babel] Writing R-packages the org way? Date: Thu, 07 Oct 2010 09:24:59 -0500 Message-ID: <4CADD83B.4000602@ccbr.umn.edu> References: Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Return-path: Received: from [140.186.70.92] (port=39591 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1P3rP7-0003Ny-7w for emacs-orgmode@gnu.org; Thu, 07 Oct 2010 10:25:06 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1P3rP6-0006i6-9U for emacs-orgmode@gnu.org; Thu, 07 Oct 2010 10:25:05 -0400 Received: from walleye.ccbr.umn.edu ([128.101.116.11]:1237) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1P3rP5-0006hh-Us for emacs-orgmode@gnu.org; Thu, 07 Oct 2010 10:25:04 -0400 In-Reply-To: List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Rainer M Krug Cc: emacs-orgmode Rainer M Krug wrote: > Hi > > I am about to write an R package, and as I am an org-mode and org-babel > user, I would (obviously) like to use org-mode for that. > > Is there a recommended way of writing an R package in org-babel, or do I > have effectively wrap the R code for the documentation etc. into source > blocks in babel? That's what I do. I've looked into converting an org-file to Roxygen or Rd markup, but never got very far. My idea at the time was to do something like: * function1 ** Help *** Title this is function 1 title *** Description function1 does this... *** Usage function1(arg1, arg2, ...) *** Arguments arg1: the first argument *** Examples function1(arg1 = x, arg2 = y) **Definition begin_src R :tangle R/package.R function1 <- function(arg1, arg2) { } > > Any suggestions how to best proceed? > > Dream: I would like to have one org file which contains everything > (documentation, code, other relevant files) and if I export or tangle > the file, I have the package ready. Well, that functionality is essentially present with code blocks and tangling, except the documentation part. > > Is there anything like that? > > Rainer > > -- > NEW GERMAN FAX NUMBER!!! > > Rainer M. Krug, PhD (Conservation Ecology, SUN), MSc (Conservation > Biology, UCT), Dipl. Phys. (Germany) > > Centre of Excellence for Invasion Biology > Natural Sciences Building > Office Suite 2039 > Stellenbosch University > Main Campus, Merriman Avenue > Stellenbosch > South Africa > > Cell: +27 - (0)83 9479 042 > Fax: +27 - (0)86 516 2782 > Fax: +49 - (0)321 2125 2244 > email: Rainer@krugs.de > > Skype: RMkrug > Google: R.M.Krug@gmail.com > > > ------------------------------------------------------------------------ > > _______________________________________________ > Emacs-orgmode mailing list > Please use `Reply All' to send replies to the list. > Emacs-orgmode@gnu.org > http://lists.gnu.org/mailman/listinfo/emacs-orgmode