Talk:NutriTools.R

From Organic Design wiki
Revision as of 01:35, 13 March 2007 by Sven (talk | contribs) (Correct install usage)

Details

The structure of this category and subcategories is very consise. It is based on the build process of the R function package.skeleton which is used to create a contributed package template.

  • Names of articles correspond to filenames for the package builds
  • Subcategories of this package are in the same structure as the package directory structure

Developers

Build process

Download the text file contents of NutriTools.R into a temporary directory. In R, using that directory as your working directory, create a skeleton from a list of functions in a working .RData directory;

rm(list=ls())
source("NutriTools.R")
package.skeleton(name="NutriTools", force=TRUE)
dest         <- "NutriTools"
buildMan     <- file.path(dest,"man")
buildManDest <- "man_build" 
myManPages   <- "man"
# Copy build template man pages to buildManDest directory
for( i in dir(buildMan)) {
  print(i)
  file.copy(from=file.path(buildMan, i), to=file.path(buildManDest,i), overwrite=FALSE)
}
# Copy my new man pages to build directory
for( i in dir(myManPages, pattern="<tt>[</tt>[:alpha:]]$")) {
  print(i)
  file.copy(from=file.path(myManPages, i), to=file.path(buildMan,i), overwrite=TRUE)
}
# Remove file "Read-and-delete-me"
unlink(file.path(dest, "Read-and-delete-me"))
# copy DESCRIPTION file
file.copy(from="DESCRIPTION", to=file.path(dest,"DESCRIPTION"), overwrite=TRUE)

To build and install the R Package, the following commands are run In the filesystem parent directory of the R Package.

R CMD check NutriTools
R CMD INSTALL --build NutriTools_[VERSION].tar.gz

To create a windows zip file on OS X/linux (doesn't include CHM help files), run the following bash shell script;

#!/bin/bash
# Rename tar.gz
mv NutriTools_1.0-0_R_powerpc-apple-darwin8.8.0.tar.gz NutriTools_1.0-0.tar.gz
# Destroy the source build from package.skeleton
rm -rf NutriTools
# Create a packaged version of the NutriTools directory structure
tar -zxvf NutriTools_1.0-0.tar.gz
# Create a zip archive for windows
zip -r NutriTools.zip NutriTools