R/TENxIO-package.R

#' TENxIO: A Bioconductor package for importing 10X Genomics files
#'
#' The package provides file classes based on `BiocIO` for common file
#' extensions found in the 10X Genomics website.
#'
#' @section Supported file types:
#' Here is a table of supported file and file extensions and their imported
#' classes:
#'
#' | **Extension**       | **Class**     | **Imported as**      |
#' |---------------------|---------------|----------------------|
#' | .h5                 | TENxH5        | SingleCellExperiment w/ TENxMatrix |
#' | .mtx / .mtx.gz      | TENxMTX       | SummarizedExperiment w/ dgCMatrix |
#' | .tar.gz             | TENxFileList  | SingleCellExperiment w/ dgCMatrix |
#' | peak_annotation.tsv | TENxPeaks     | GRanges              |
#' | fragments.tsv.gz    | TENxFragments | RaggedExperiment     |
#' | .tsv / .tsv.gz      | TENxTSV       | tibble               |
#'
#' @import SummarizedExperiment SingleCellExperiment
#'
#' @docType package
#'
#' @aliases TENxIO-package
#'
#' @name TENxIO
#'
"_PACKAGE"
LiNk-NY/TENxIO documentation built on May 3, 2024, 11:08 p.m.