basecallQC: The basecallQC object and constructor.

Description Usage Arguments Details Value Examples

View source: R/allClasses.R

Description

Object and method to handle Illumina basecalling/demultiplexing inputs and output files. Provides sample sheet cleanup, basecall command and summary QC statistics for basecalling/demultiplexing.

The basecallQC object and constructor.

Usage

1
2
basecallQC(bcl2fastqparams, RunMetaData = NULL, sampleSheet = NULL,
  doFQMetric = FALSE)

Arguments

bcl2fastqparams

A BCL2FastQparams object as created by BCL2FastQparams() constructor.

RunMetaData

Any run metadata to attach (data.frame)

sampleSheet

A sample sheet for Illumina basecalling using bcl2Fastq (See vignette for more details).

doFQMetric

TRUE or FALSE. Perform ShortRead FastQ quality assessment using ShortRead's qa and report function

Details

The basecallQC object contains slots BCL2FastQparams, cleanedSampleSheet, baseMasks, BCLCommand, baseCallMetrics, demultiplexMetrics and fqQCmetrics.

Value

basecallQC a basecallQC object (See details for more information)

Examples

1
2
3
4
5
6
7
fileLocations <- system.file("extdata",package="basecallQC")
runXML <- dir(fileLocations,pattern="runParameters.xml",full.names=TRUE)
config <- dir(fileLocations,pattern="config.ini",full.names=TRUE)
sampleSheet <- dir(fileLocations,pattern="*\\.csv",full.names=TRUE)
outDir <- file.path(fileLocations,"Runs/161105_D00467_0205_AC9L0AANXX/C9L0AANXX/")
bcl2fastqparams <- BCL2FastQparams(runXML,config,runDir=getwd(),outDir,verbose=FALSE)
bclQC <- basecallQC(bcl2fastqparams,RunMetaData=NULL,sampleSheet)

basecallQC documentation built on Nov. 8, 2020, 8:03 p.m.