From mboxrd@z Thu Jan 1 00:00:00 1970 From: Dan Davison Subject: Re: [babel] Writing R-packages the org way? Date: Thu, 07 Oct 2010 16:03:45 +0100 Message-ID: <8762xeniy6.fsf@stats.ox.ac.uk> References: <4CADD83B.4000602@ccbr.umn.edu> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Received: from [140.186.70.92] (port=46834 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1P3s1J-0001qM-E8 for emacs-orgmode@gnu.org; Thu, 07 Oct 2010 11:04:35 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1P3s1I-0006ES-0O for emacs-orgmode@gnu.org; Thu, 07 Oct 2010 11:04:33 -0400 Received: from markov.stats.ox.ac.uk ([163.1.210.1]:36196) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1P3s1H-0006Di-Mn for emacs-orgmode@gnu.org; Thu, 07 Oct 2010 11:04:31 -0400 In-Reply-To: <4CADD83B.4000602@ccbr.umn.edu> (Erik Iverson's message of "Thu, 07 Oct 2010 09:24:59 -0500") 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: Erik Iverson Cc: emacs-orgmode , Rainer M Krug Erik Iverson writes: > 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. Hi Erik, Would you mind expanding on that -- what are we missing for the documentation part? Dan