zipModule: Create a zip archive of a module subdirectory

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Create a zip archive of a module subdirectory

Description

The most common use of this would be from a "modules" directory, rather than inside a given module.

Usage

zipModule(name, path, version, data = FALSE, ...)

## S4 method for signature 'character,character,character'
zipModule(name, path, version, data = FALSE, ...)

## S4 method for signature 'character,missing,character'
zipModule(name, path, version, data = FALSE, ...)

## S4 method for signature 'character,missing,missing'
zipModule(name, path, version, data = FALSE, ...)

## S4 method for signature 'character,character,missing'
zipModule(name, path, version, data = FALSE, ...)

Arguments

name	Character string giving the module name.
path	A file path to a directory containing the module subdirectory.
version	The module version.
data	Logical. If TRUE, then the data subdirectory will be included in the zip. Default is FALSE.
...	Additional arguments to zip(): e.g., add "-q" using flags="-q -r9X" (the default flags are "-r9X").

Value

NULL (invisibly). Invoked for its side effect of zipping module files.

Author(s)

Eliot McIntire and Alex Chubaty

SpaDES.core documentation built on June 22, 2024, 10:32 a.m.