Package Source to Binary

DESCRIPTION:

A S-PLUS package utility used to create the binary version of a package from source files. This utility installs S code and data, compiles C, C++ and FORTRAN code to create a shared/dynamic library, and formats and installs help files.

USAGE:

Splus CMD src2bin

OPTIONAL ARGUMENTS:

-h, --help
print the usage message.
--name packageName
name of directory containing the package source. "parentDir/packageName" is the full path to the package source. The default is the current working directory.
--parent parentDir
parent directory of package source. The default is the current working directory.
--directory directory
directory containing the package source. Use this argument in place of arguments --name and --parent. The default is the current working directory.
--clean-first
delete old binary objects before making new ones.
--no-shlib
do not compile code from src directory to make a shared/dynamic library.
--no-sinstall
do not install S functions from R directory.
--no-helpinstall
do not install help files from man directory.
--no-datainstall
do not install data files from data directory.
-v, --verbose
give more detailed progress reports.

SIDE EFFECTS:

A binary package is created from source files.

DETAILS:

If your current working directory is the package directory, then none of these arguments are necessary: --directory --name , --parent.

This utility does the following:
- S code from the package's "R" directory is installed.
- C, C++, and FORTRAN files located in the "src" directory are compiled, and a shared (UNIX) or dynamic (Windows) library is created.
- Data objects from the "data" directory are installed.
- Help files in the "man" directory are formatted and installed.

All help file must be located in the "man" directory and be in the .Rd format. Files having the ".sgml" extension will be ignored.

The src2bin utility is invoked from the operating system's command line using the S-PLUS CMD utility. src2bin is based on Perl code.

SEE ALSO:

Read Guide to S-PLUS Packages for more information.
S-PLUS functions and (in the pkgutils library).
Other package utilities: (and DATAINSTALL), , , .

EXAMPLES:

# in S-PLUS, create package source
library(pkgutils)
package.skeleton("myPkg", list=c("func1", "func2", "dataA", "dataB"))

# from the OS command line:
#  - put C, C++ or FORTRAN code into the "src" directory
#  - edit help files skeletons in the "man" directory
Splus CMD src2bin --name myPkg --clean-first

# in S-PLUS, install the package
library(myPkg, lib.loc=".")
objects("myPkg")