From: Dan Davison <davison@stats.ox.ac.uk>
To: Erik Iverson <eriki@ccbr.umn.edu>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>,
Rainer M Krug <r.m.krug@gmail.com>
Subject: Re: [babel] Writing R-packages the org way?
Date: Thu, 07 Oct 2010 16:03:45 +0100 [thread overview]
Message-ID: <8762xeniy6.fsf@stats.ox.ac.uk> (raw)
In-Reply-To: <4CADD83B.4000602@ccbr.umn.edu> (Erik Iverson's message of "Thu, 07 Oct 2010 09:24:59 -0500")
Erik Iverson <eriki@ccbr.umn.edu> 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
next prev parent reply other threads:[~2010-10-07 15:04 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-10-07 14:02 [babel] Writing R-packages the org way? Rainer M Krug
2010-10-07 14:24 ` Erik Iverson
2010-10-07 15:03 ` Dan Davison [this message]
2010-10-07 15:12 ` Erik Iverson
2010-10-07 15:59 ` Dan Davison
2010-10-07 16:18 ` Rainer M Krug
2010-10-07 16:04 ` Rainer M Krug
2010-10-07 17:16 ` Dan Davison
2010-10-08 4:29 ` Charles C. Berry
2010-10-08 12:10 ` Dan Davison
2010-10-08 13:09 ` Stephen Eglen
2010-10-08 15:41 ` Rainer M Krug
2010-10-08 15:35 ` Rainer M Krug
2010-10-07 14:25 ` Dan Davison
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8762xeniy6.fsf@stats.ox.ac.uk \
--to=davison@stats.ox.ac.uk \
--cc=emacs-orgmode@gnu.org \
--cc=eriki@ccbr.umn.edu \
--cc=r.m.krug@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).