Skip to contents

Import a ROCK project from a ROCKproject file

Source: R/import_ROCKproject.R
import_ROCKproject.Rd

Import a ROCK project from a ROCKproject file

Usage

import_ROCKproject(
  input,
  path = ".",
  createDirs = FALSE,
  preventOverwriting = TRUE,
  forceBaseZip = FALSE,
  silent = rock::opts$get(silent)
)

Arguments

input

The path to the ROCK project file (typically with the extension .ROCKproject)

path

The path where to store the ROCK project

createDirs

Whether to, if the path does not exist, create it

preventOverwriting

If the path already contains files, whether to prevent them 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

Value

Invisibly, output.

Examples

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

### Get a temporary directory to write to
temporaryDir <-
  tempdir();

### Import the project
rock::import_ROCKproject(
  input = exampleProjectFile,
  path = temporaryDir,
  silent = FALSE
);