registry-utils {GenomicFiles}R Documentation

Functions for creating and searching a registry of file types.

Description

Functions for creating and searching a registry of file types based on file extension.

Usage

  registerFileType(type, package, regex)
  findTypeRegistry(fnames)
  makeFileType(fnames, ..., regex=findTypeRegistry(fnames))

Arguments

type

The List class the file is associated with such as BamFileList, BigWigFileList, FaFileList.

package

The package where the List class (type) is defined.

regex

A regular expression that uniquely identifies the file extension.

fnames

A character vector of file names.

...

Additional arguments passed to the List-class constructor (e.g., yieldSize for BamFileList).

Details

Value

registerFileType: NULL

findTypeRegistry: The regular expression associated with the file.

makeFileType: A List-type object defined in the registry.

Examples


## At load time the registry is populated with file types
## known to GenomicFiles.
sapply(as.list(.fileTypeRegistry), "[", "type")

## Add a new class to the file register.
## Not run: registerFileType(NewClassList, NewPackage, "\.NewExtension$")

[Package GenomicFiles version 1.29.0 Index]