helper.functions: Helper functions

helper.functionsR Documentation

Helper functions

Description

Functions for printing help, tarring, zipping, and moving files.

Usage

show.tool.help(tool)

tgz.directories(location, match.pattern = NULL, n.cores = 1)

remove.directories(location, match.pattern = NULL, n.cores = 1)

gzip.files(location, match.pattern = NULL, n.cores = 1)

gunzip.files(location, match.pattern = NULL, n.cores = 1)

move.files(move.from, move.to, match.pattern = NULL, n.cores = 1)

Arguments

tool

character; name of the appropriate tool, e.g. "kneaddata" or "humann".

location

character; path to directory with files/directories you want to manipulate.

match.pattern

character; pattern to match desired files and directories. Default NULL

n.cores

integer; if 1, will run serially, otherwise will extract in parallel utilzing up to the number of cores specified. Default is 1.

move.from

character; path to directory you want to move files/directories from.

move.to

character; path to directory you want to move files/directories to.

See Also

system, generate.full.commands, generate.tool.commands


kstagaman/sharpton-lab-metaGTx.processing documentation built on Oct. 2, 2022, 4:39 p.m.