Pack Up a Package

DESCRIPTION:

A S-PLUS package utility used to pack up a package directory into a either a compressed tar file (UNIX) or a zip file (Windows).

USAGE:

Splus CMD packup

OPTIONAL ARGUMENTS:

-h, --help
print usage message.
--name packageName
name of directory containing the package. "parentDir/packageName" is the full path to the package. The default is the current working directory.
--parent parentDir
parent directory of package. The default is the current working directory.
--directory directory
directory containing the package. Use this argument in place of arguments --name and --parent. The default is the current working directory.
--type binary|source
if the value is binary then include the compiled and installed code, or if source then only include the source files.
--no-clean-after
do not remove unneeded files and directories after packing up. The temporary directory that is created during packing up is not deleted.
--compress-with zip|tar.gz
specifies the compression program to use. If the value is zip then use the "zip" utility, and the file extension will be ".zip". If the value is tar.gz then use "tar" followed by "gzip", and the file extension will be ".tar.gz". The default is tar.gz on UNIX systems and zip on Windows.
-v, --verbose
give more detailed progress reports.

SIDE EFFECTS:

A compressed file is created containing the either the entire package contents or only the source files. This file will be located in the current working directory. The name of the file has this format: "pkgName_pkgVersion.{tar.gz|zip}", where "pkgName" is the value of the --name argument, if given, or the basename of the directory containing the package. The package version number is specified in the package's DESCRIPTION file.

DETAILS:

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

Currently, the --type source option is not implemented.

Before packing up the package, all files are copied into a temporary directory, and text files are changed to have Unix line endings (as with R).

The format of the package directory should be the same as when the function package.skeleton is used to create a package directory.

If the argument --compress-with is omitted, then the default is tar.gz on UNIX systems and zip on Windows.

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

SEE ALSO:

Read Guide to S-PLUS Packages for more information.
, , .

EXAMPLES:

# pack up the contents of the current working directory
Splus CMD packup 

# pack up the contents of mySplus/library/myPkg
Splus CMD packup  --name myPkg --parent mySplus/library

# pack up the contents of myPkg using zip
Splus CMD packup  --name myPkg --compress-with zip