ExperimentPath-class: (Legacy) "ExperimentPath" class representing a file hierarchy...

In Bioconductor/ShortRead: FASTQ input and manipulation

(Legacy) "ExperimentPath" class representing a file hierarchy of data files

Description

Short read technologies often produce a hierarchy of output files. The content of the hierarchy varies. This class represents the root of the file hierarchy. Specific classes (e.g., SolexaPath) represent different technologies.

Objects from the Class

Objects from the class are created by calls to the constructor:

ExperimentPath(experimentPath)

experimentPath

character(1) object pointing to the top-level directory of the experiment; see specific technology classes for additional detail.

verbose=FALSE

(optional) logical vector which, when TRUE results in warnings if paths do not exist.

All paths must be fully-specified.

Slots

ExperimentPath has one slot, containing a fully specified path to the corresponding directory (described above).

basePath

See above.

The slot is accessed with experimentPath.

Extends

Class ".ShortReadBase", directly.

Methods

Methods include:

show

signature(object = "ExperimentPath"): briefly summarize the file paths of object.

detail

signature(x = "ExperimentPath"): summarize file paths of x.

Author(s)

Michael Lawrence

Examples

showClass("ExperimentPath")

Bioconductor/ShortRead documentation built on Nov. 2, 2024, 4:38 p.m.