[Genabel-commits] r1932 - pkg/GenABEL-general/distrib_scripts

[noreply at r-forge.r-project.org]

Author: lckarssen
Date: 2015-03-30 11:47:51 +0200 (Mon, 30 Mar 2015)
New Revision: 1932

Added:
   pkg/GenABEL-general/distrib_scripts/README.txt
Log:
Added a README.txt file to the distrib_script directory explaining how to use the makedistrib scripts.


Added: pkg/GenABEL-general/distrib_scripts/README.txt
===================================================================
--- pkg/GenABEL-general/distrib_scripts/README.txt	                        (rev 0)
+++ pkg/GenABEL-general/distrib_scripts/README.txt	2015-03-30 09:47:51 UTC (rev 1932)
@@ -0,0 +1,50 @@
+The scripts in this directory help in creating proper R packages of
+the various tools in GenABEL suite. The basic idea of these scripts is
+that when you run them, the package code (and depencies) are checked
+out from SVN and R CMD check/build is run both with and without the
+--as-cran option to see if a proper package can be created. If all
+goes well, a packageABEL_x.y-z.tar.gz is created that (if no
+warnings/errors were shown) can be uploaded to CRAN.
+
+The makedistrib scripts have several command line options. See the
+header of each makedistrib_*.sh script for details.
+
+NOTE: the text below is in Emacs org-mode (www.orgmode.org). If you
+don't know the org-mode syntax, please try to ignore the = signs
+around file names and command line options, as well as the #begin_src
+and #end_src lines.
+
+* Using the =makedistrib_*ABEL.sh= scripts
+  - Create an empty build directory, go into it and checkout the
+    =makedistrib= scripts (add an SVN user name if you expect to make
+    changes to the distrib scripts):
+    #+begin_src sh
+    mkdir xABEL_build
+    cd xABEL_build
+    svn co \
+       svn+ssh://svn.r-forge.r-project.org/svnroot/genabel/pkg/GenABEL-general/distrib_scripts
+    #+end_src
+  - Run
+    #+begin_src sh
+    ./distrib_scripts/makedistrib_xABEL.sh
+    #+end_src
+    to check out the package code and run the checks.
+  - If you want to be able to edit and commit changes to the package to
+    SVN use the =-u= option to check out with a user name.
+  - The =-n= option can be used after a first run of the =makedistrib=
+    script. When using this option the existing package files will not be
+    deleted or checked out from SVN. Use this if you want to try some
+    changes and see if the package still builds.
+  - In order to create the =.Rd= files based on the Roxygen2 in-code
+    documentation run the following steps in R (in your build directory
+    after running the =distrib_scripts/makedistrib_xABEL.sh= script):
+    #+begin_src R
+    library(devtools)
+    load_all("xABEL")
+    document("xABEL")
+    #+end_src
+    and run the makedistrib script with the =-n= option to check
+    again.
+  - After doing all your checks and commits, do a final commit
+    without the =-u= and =-n= options to get rid of the =.svn=
+    directory.