Reproducible Research Template

Reproducible Research Template

[Andy Choens]

[-- Attachment #1.1: Type: text/plain, Size: 1479 bytes --]

I am developing a reproducible research template for R. I am trying to
implement most of a research "compendium" in org. I say "most" because I
am going to allow the actual data to exist outside of org, simply
because most of the data I work with is relational or very large, which
makes storage in plain text problematic or impossible.

Has anyone ever implemented a reproducible research template in org that
I can look at? I looked at the stuff on Worg and there are examples of a
project, but not a template.

In a nutshell, I am trying to do two things.
    1) Provide a structure for reproducible research / programming ;
    2) Provide a small set of helper functions.

But, I don't want the helper functions to get in the way. I have
considered two options:
    1) Store the example code / template stuff in subheadings 
    2) Store the example code / template stuff in an external file.  

Using subheadings is tempting, but I'm afraid that
org-babel-execute-buffer would cause problems for users who don't use
all of the template functions. 

Using an external file, similar to the Lobrary of Babel is also
tempting. It would allow me to make a cleaner template for structure and
still allow users to access any helper functions. Is there a way to link
to an external file, other than the Library of Babel? If so, how do I do
this?

Does anyone have any opinions about hiding/linking/importing example
code in a template?

I certainly appreciate any thoughts.

--andy

[-- Attachment #1.2: Type: text/html, Size: 1873 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
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

Re: Reproducible Research Template

[Thomas S. Dye]

On Jan 4, 2011, at 9:55 AM, Andy Choens wrote:

> I am developing a reproducible research template for R. I am trying  
> to implement most of a research "compendium" in org. I say "most"  
> because I am going to allow the actual data to exist outside of org,  
> simply because most of the data I work with is relational or very  
> large, which makes storage in plain text problematic or impossible.
>
> Has anyone ever implemented a reproducible research template in org  
> that I can look at? I looked at the stuff on Worg and there are  
> examples of a project, but not a template.
>
> In a nutshell, I am trying to do two things.
>     1) Provide a structure for reproducible research / programming ;
>     2) Provide a small set of helper functions.
>
> But, I don't want the helper functions to get in the way. I have  
> considered two options:
>     1) Store the example code / template stuff in subheadings
>     2) Store the example code / template stuff in an external file.
>
> Using subheadings is tempting, but I'm afraid that org-babel-execute- 
> buffer would cause problems for users who don't use all of the  
> template functions.
>
> Using an external file, similar to the Lobrary of Babel is also  
> tempting. It would allow me to make a cleaner template for structure  
> and still allow users to access any helper functions. Is there a way  
> to link to an external file, other than the Library of Babel? If so,  
> how do I do this?
>
> Does anyone have any opinions about hiding/linking/importing example  
> code in a template?
>
> I certainly appreciate any thoughts.
>
> --andy

Aloha Andy,

Great idea.  I'll be interested to see where you go with this.

You can link to an external file other than the one holding the  
library of babel using the library of babel facility.  I use this in  
my config file:

#+source: load-local-lob
#+begin_src emacs-lisp :tangle yes
   (org-babel-lob-ingest "~/org/local-lob.org")
#+end_src

I put functions there that are useful to me in more than one Org-mode  
buffer, but that are not likely to be useful to other Org-mode users  
(and therefore fit for the library of babel).

Most of my projects store data in a MySQL database.  My projects  
define queries that relate tables to one another, but the results are  
typically something that Org-mode understands---a flat table or a  
single value.  The reproducible research functions that I write break  
the analysis workflow down into separate tasks so that the results of  
a SQL query are written to the Org-mode buffer.  Subsequent steps in  
the workflow refer to the named results block.  This way, the Org-mode  
project contains the actual data used in the analysis without the need  
to reproduce a relational structure.  The functions that access the  
SQL database go in the local library of babel because I don't want to  
give users of a RR document direct access to my database.

If I manipulate query results after they are written into the Org-mode  
buffer, I also like to write out intermediate results in many  
situations.  My goal in writing RR code is not speed or compactness,  
but maximum transparency.  Because Org-mode is language agnostic it is  
frequently the case that the files created by others contain code in  
languages I don't understand.  If these are long and complex, then I'm  
at a loss to what is actually going on.  If they are short, and  
intermediate results are written out in the buffer, then it is easier  
for me to follow the analysis.

I look forward to learning from your work with RR templates.

All the best,
Tom

Re: Reproducible Research Template

[Charles C. Berry]

On Tue, 4 Jan 2011, Andy Choens wrote:

> I am developing a reproducible research template for R. I am trying to
> implement most of a research "compendium" in org. I say "most" because I
> am going to allow the actual data to exist outside of org, simply
> because most of the data I work with is relational or very large, which
> makes storage in plain text problematic or impossible.
>
> Has anyone ever implemented a reproducible research template in org that
> I can look at? I looked at the stuff on Worg and there are examples of a
> project, but not a template.
>
> In a nutshell, I am trying to do two things.
>    1) Provide a structure for reproducible research / programming ;
>    2) Provide a small set of helper functions.
>
> But, I don't want the helper functions to get in the way. I have
> considered two options:
>    1) Store the example code / template stuff in subheadings
>    2) Store the example code / template stuff in an external file.


One version of 'store the example code / template stuff' externally is to 
create an R package that holds the helper functions and whose example()s 
and/or demo()s show off the capabilities of helper functions.

The R package 'inst' directory can hold miscellaneous files including 
suitable *.org templates, SQL snippets, etc.  for different kinds of 
research projects.

Then carrying out the research project would consist of starting R, 
require()-ing that package, issuing a command like

 	choose.template( my.type.of.project, "myLocalWorkfile.org" ,
 				my.options )

(which would generate the starting template as myLocalWortkfile.org), and 
carrying on.

HTH,

Chuck

p.s. You probably know that you can master the R package in a *.org file, 
but just in case:

http://orgmode.org/worg/org-contrib/babel/examples/Rpackage.html#sec-6_1



>
> Using subheadings is tempting, but I'm afraid that
> org-babel-execute-buffer would cause problems for users who don't use
> all of the template functions.
>
> Using an external file, similar to the Lobrary of Babel is also
> tempting. It would allow me to make a cleaner template for structure and
> still allow users to access any helper functions. Is there a way to link
> to an external file, other than the Library of Babel? If so, how do I do
> this?
>
> Does anyone have any opinions about hiding/linking/importing example
> code in a template?
>
> I certainly appreciate any thoughts.
>
> --andy
>

Charles C. Berry                            Dept of Family/Preventive Medicine
cberry@tajo.ucsd.edu			    UC San Diego
http://famprevmed.ucsd.edu/faculty/cberry/  La Jolla, San Diego 92093-0901

Re: Reproducible Research Template

[Andy Choens]

[-- Attachment #1.1: Type: text/plain, Size: 1155 bytes --]


On Wed, 2011-01-05 at 06:24 -1000, Thomas S. Dye wrote:

> Most of my projects store data in a MySQL database.  My projects  
> define queries that relate tables to one another, but the results
> are  
> typically something that Org-mode understands---a flat table or a  
> single value.  The reproducible research functions that I write
> break  
> the analysis workflow down into separate tasks so that the results
> of  
> a SQL query are written to the Org-mode buffer.  Subsequent steps in  
> the workflow refer to the named results block.  This way, the
> Org-mode  
> project contains the actual data used in the analysis without the
> need  
> to reproduce a relational structure.  The functions that access the  
> SQL database go in the local library of babel because I don't want
> to  
> give users of a RR document direct access to my database.
> 


That is very interesting. I like the idea of separating the database
queries from the flat table results. This is similar to my situation.
The actual storage of the data is relational, but the queries needed to
assess the data result in either flat tables or single values. Very good
idea.

[-- Attachment #1.2: Type: text/html, Size: 1984 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
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