[GenABEL-dev] GenABEL tutorials to SVN

[Maarten Kooyman]

Dear All,

I think on the long run replacing the data is the best thing to do. 
(although it will take quite some effort).

As an temporary solution we could use a build server with jenkins 
(http://jenkins-ci.org/), that recreates the document after each 
alteration on svn and publish this on a public place(by coping it to a 
webserver). On this build server the datasets are secure in a trusted 
environment and the results are visible to the outer world. I use  
Jenkins also  for monitoring Probabel, but the goal is the same: keep 
the quality of the code in check.

This solution prevent coping binary files to svn and this can be done in 
a completely automated way.

Kind regards,

Maarten


On 02/20/2013 06:54 PM, L.C. Karssen wrote:
> Dear Yurii,
>
> Great idea. I'm all for putting the tutorials in SVN. They are already
> of high quality and together with our community we can make them even
> better.
> I do see the problem with the data sets, of course.
>
> You are using Sweave, right? I'm wondering how much not having the data
> will impact the possibility to tweak the document. Fixing small typos
> will be alright, but before you know it a typo can mess up the LaTeX or
> R code and since you can't compile the document to check it this may
> lead to a lot of bug hunting for you, once you recompile it again.
> That's the only potential problem I see.
>
> How about also including the latest PDF version of the tutorial (I know,
> this is against SVN's principles) each time you compile a version? This
> way people who don't have the data know what it is supposed to look like
> and could even help creating replacement data sets.
>
>
> Best,
>
> Lennart.
>
> On 02/20/2013 04:35 PM, Yurii Aulchenko wrote:
>> Dear All,
>>
>> For long time I was thinking that GenABEL tutorial(s) should be a part of
>> the project - the same logic as with the code, with the same idea that in
>> such case people can easily contribute by submitting patches and new
>> pieces.
>>
>> The problem was (and still is) that the tutorial uses some data sets, which
>> are not public domain, and it is quite awkward if we as the project start
>> re-distributing them. Little by little I am trying to switch the whole
>> thing to the use of only public and simulated data, but this is a lengthy
>> process.
>>
>> So I thought that may be a good solution is to put the code of tutorials on
>> our SVN; and put the data only if these are either public or simulated. Of
>> cause in this way the tutorials will not be really "functional" (e.g. they
>> would not compile right away), but this may become a starting point for
>> others to build up something new and really
>> free-for-all-to-use-and-contribute.
>>
>> Let me know what you think,
>> best regards,
>> Yurii
>>
>>
>>
>> _______________________________________________