fqName {ngsReports}

R Documentation

Return the Underlying Fastq File Names from FastqcData* Objects

Description

Return the Underlying Fastq File Names from FastqcData* Objects

Usage

fqName(object)

## S4 method for signature 'ANY'
fqName(object)

## S4 method for signature 'FastqcData'
fqName(object)

## S4 method for signature 'FastqcDataList'
fqName(object)

fqName(object) <- value

## S4 replacement method for signature 'FastqcData'
fqName(object) <- value

## S4 replacement method for signature 'FastqcDataList'
fqName(object) <- value

Arguments

object	An object of class FastqcData or FastqcDataList
value	Replacement value for fqName

Value

Returns the names of the Fastq files the FastQC report was generated from, without any preceding directories.

Examples

# Get the files included with the package
packageDir <- system.file("extdata", package = "ngsReports")
fl <- list.files(packageDir, pattern = "fastqc.zip", full.names = TRUE)

# Load the FASTQC data as a FastqcDataList object
fdl <- FastqcDataList(fl)
fqName(fdl)

nm <- paste0(letters[seq_along(fdl)], ".fq")
fqName(fdl) <- nm
fqName(fdl)

---