rock (version 0.9.6)

export_ROCKproject: Export a ROCK project to a single ROCKproject file

Description

Export a ROCK project to a single ROCKproject file

Usage

export_ROCKproject(
  output,
  path = ".",
  config = NULL,
  includeRegex = NULL,
  excludeRegex = NULL,
  createDirs = FALSE,
  preventOverwriting = TRUE,
  forceBaseZip = FALSE,
  silent = rock::opts$get("silent")
)

Value

Invisibly, output.

Arguments

output

The file to write to; should have the extension .ROCKproject

path

The path with the ROCK project

config

Optionally, a named list with configuration options to override. For supported options, see vignette("ROCKproject-format", package = "rock");

includeRegex

A regular expression used to select files to include in the project file

excludeRegex

A regular expression used to omit files from the project file; selection takes place after the selection by includeRegex

createDirs

Whether to, if any directories in the output path does not exist, create these

preventOverwriting

If the output file already exists, whether to prevent it from being overwritten (TRUE) or not (FALSE).

forceBaseZip

Whether to force using the zip() function included in R even if the zip package is installed.

silent

Whether to be chatty or silent

Examples

### Get path to example project
examplePath <-
  system.file(
    "ROCKprojects",
    "exportable-ROCKproject-1",
    package="rock"
  );

### Get a temporary filename to write to
projectFilename <-
  tempfile(
    fileext = ".ROCKproject"
  );

### Export it
rock::export_ROCKproject(
  path = examplePath,
  output = projectFilename,
  silent = FALSE
);