setFastFilter: Create a fastFilter object

Description Usage Arguments

View source: R/setup.R

Description

Create a fastFilter object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
setFastFilter(
  inDir,
  outDir,
  prefix = "myproject",
  validate = FALSE,
  maxEE = 2.5,
  truncQ = 0,
  truncLen = 0,
  trimLeft = 0,
  trimRight = 0,
  matchIDs = FALSE,
  minLen = 50,
  isPaired = FALSE,
  verbose = FALSE,
  multithread = FALSE
)

Arguments

inDir

Required input. Path to FASTQ files.

outDir

Required input. Path to write output files.

prefix

Default is "myproject". Project-specific label that will be included in the names of all files and directories created.

validate

Default is FALSE. When TRUE all validation methods are executed.

maxEE

Default is 2.5. Sets maxEE parameter for DADA2's filterAndTrim method. Two numeric inputs are expected for paired-end data.

truncQ

Default is 0. Sets truncQ parameter for DADA2's filterAndTrim method. Two numeric inputs are expected for paired-end data.

truncLen

Default is 0. Sets truncLen parameter for DADA2 filterAndTrim function. Two numeric inputs are expected for paired-end data.

trimLeft

Default is 0. Sets trimLeft parameter for DADA2 filterAndTrim function. Two numeric inputs are expected for paired-end data.

trimRight

Default is 0. Sets trimRight parameter for DADA2 filterAndTrim function. Two numeric inputs are expected for paired-end data.

matchIDs

Default is FALSE. Sets matchIDs parameter for DADA2 filterAndTrim function. Set TRUE when handling paired-end data with complementary file names for forward and reverse reads.

minLen

Default is 50. Sets minLen parameter for DADA2 filterAndTrim function. Two numeric inputs are expected for paired-end data.

isPaired

Default is FALSE. If TRUE, two values must be provided for truncQ, truncLen, trimLeft and trimRight, and minLen (see example below).

TODO: Add Example

verbose

Default is FALSE. Sets verbose parameter for DADA2 methods.

multithread

Default is FALSE. Sets multithread parameter for DADA2 methods.


ananata/fastq2otu documentation built on Feb. 2, 2022, 4:20 p.m.