bzip2: Wrapper function for bzip2

View source: R/wrapperFunctions_fastxtoolkit.R

bzip2R Documentation

Wrapper function for bzip2

Description

Wrapper function for bzip2

Usage

bzip2(
  fileToBzip2,
  bzip2 = "Bzip2",
  keep = TRUE,
  force = FALSE,
  small = FALSE,
  blockSize = 1,
  stderr = file.path(dirname(fileToBzip2), paste0(basename(fileToBzip2),
    "_Bzip2_stderr.txt")),
  stdout = file.path(dirname(fileToBzip2), paste0(basename(fileToBzip2),
    "_Bzip2_stdout.txt")),
  useClipRConda = ifelse(is.null(getOption("CLIPflexR.condaEnv")), FALSE, TRUE),
  additional_Args = NULL,
  verbose = FALSE
)

Arguments

fileToBzip2

path to file to bzip.

bzip2

path to bzip2.

keep

keep (don't delete) input files, TRUE (default) or FALSE.

force

overwrite existing output files.

small

use less memory (at most 2500k).

blockSize

set block size to 100k .. 900k.

stderr

path to stderr file.

stdout

path to stdout file.

useClipRConda

use conda environment installed by Herper, TRUE (default) or FALSE.

additional_Args

additional arguments to be passed to system call.

verbose

print messages to screen, TRUE or FALSE (default).

Value

path to bzipped file.

Author(s)

Kathryn Rozen-Gagnon


kathrynrozengagnon/CLIPflexR documentation built on Dec. 8, 2022, 7:31 p.m.