checkArgsAgainstBatchParams: Check Function Arguments against Batch-Specific Parameters

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

Check Function Arguments against Batch-Specific Parameters

Description

If a processing batch is currently set, inserting this function into another function from neonMicrobe will check the parent function's arguments against the parameters associated with the current processing batch. If priority = "batch", the current batch's parameters would take precedence.

Usage

checkArgsAgainstBatchParams(
  priority = c("batch", "arguments"),
  ...,
  verbose = TRUE,
  warn_no_batch = FALSE
)

Arguments

priority	Must be "batch" or "arguments". Whether to defer to batch-specific processing parameters or function arguments when they conflict.
...	Format function argument (string or name) = batch parameter (string). Arguments with a corresponding batch parameter, set to whatever the name of that batch parameter is, e.g. ⁠maxEE = "MAX_EE_FWD⁠. The arguments will be checked against the batch parameters.
verbose	Default TRUE. Whether to print a warning if the function argument and batch parameter do not match.
warn_no_batch	Default FALSE. Whether to print a warning if there is no current processing batch.

Details

If priority = "batch", then rather than using quality filtering parameters defined on-the-fly as function arguments, the parent function would instead use the quality filtering parameters associated with the current batch. If priority = "batch", then rather than using the default output directory, the parent function would instead use the batch-specific outputs.

Value

No value is returned

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