newBatch: Create New Processing Batch

In claraqin/neonMicrobe: Downloading, Pre-processing, and Assembling NEON Soil Microbe Marker Gene Sequence Data

Create New Processing Batch

Description

Creates and switches to a new processing batch for enhancing the reproducibility of NEON soil microbe marker gene sequence workflows. Set batch processing parameters with setBatchParam, or view them with getBatchParam.

Usage

newBatch(seqmeta_file, batch_id = NULL, batches_dir = NULL, overwrite = FALSE)

Arguments

seqmeta_file	Character string. File path to the sequence metadata to associate with this processing batch. Once set, this cannot be changed except by overwriting this batch.
batch_id	Character string. Unique ID to use for the new processing batch.
batches_dir	Directory where batch-specific directories are saved. By default (NULL), saves in NEONMICROBE_DIR_BATCHES().
overwrite	Default FALSE. If processing batch already exists in the specified directory, whether to overwrite it.

Value

No value returned

Examples

## Not run: 
newBatch("data/sequence_metadata/mmg_soilMetadata_ITS_2021-03-08134134.csv") # creates new batch based on timestamp
newBatch("data/sequence_metadata/mmg_soilMetadata_ITS_2021-03-08134134.csv", batch_id="abc") # creates new batch based on user-specified name

## End(Not run)

claraqin/neonMicrobe documentation built on April 11, 2024, 11:47 a.m.