Skip to content

Commit 1cd0e7a

Browse files
committed
create a table of common classes
1 parent ca4aa04 commit 1cd0e7a

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

bioc-classes-methods.Rmd

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,29 +46,21 @@ the Bioconductor project.
4646

4747
### Common Classes {#commonclass}
4848

49-
The following list, though certainly not exhaustive, provides select classes and
50-
constructor functions to represent genomic data:
51-
52-
+ Rectangular feature x sample data --
53-
`r BiocStyle::Biocpkg("SummarizedExperiment")` `::SummarizedExperiment()`
54-
(RNAseq count matrix, microarray, ...)
55-
+ Genomic coordinates -- `r BiocStyle::Biocpkg("GenomicRanges")` `::GRanges()`
56-
(1-based, closed interval)
57-
+ Genomic coordinates from multiple samples --
58-
`r BiocStyle::Biocpkg("GenomicRanges")` `::GRangesList()`
59-
+ Ragged genomic coordinates -- `r BiocStyle::Biocpkg("RaggedExperiment")`
60-
`::RaggedExperiment()`
61-
+ DNA / RNA / AA sequences -- `r BiocStyle::Biocpkg("Biostrings")`
62-
`::*StringSet()`
63-
+ Gene sets -- `r BiocStyle::Biocpkg("BiocSet")` `::BiocSet()`,
64-
`r BiocStyle::Biocpkg("GSEABase")` `::GeneSet()`,
65-
`r BiocStyle::Biocpkg("GSEABase")` `::GeneSetCollection()`
66-
+ Multi-omics data --
67-
`r BiocStyle::Biocpkg("MultiAssayExperiment")` `::MultiAssayExperiment()`
68-
+ Single cell data --
69-
`r BiocStyle::Biocpkg("SingleCellExperiment")` `::SingleCellExperiment()`
70-
+ Mass spec data -- `r BiocStyle::Biocpkg("Spectra")` `::Spectra()`
71-
+ File formats -- `r BiocStyle::Biocpkg("BiocIO")` `` ::`BiocFile-class` ``
49+
The following table, though certainly not exhaustive, provides select classes
50+
and constructor functions to represent genomic data:
51+
52+
| Data Type | Package and Function | Description |
53+
|-------------------------------|----------------------------------------------------------|--------------------------------------------------------|
54+
| Rectangular feature by sample | `r BiocStyle::Biocpkg("SummarizedExperiment")` `::SummarizedExperiment()` | RNAseq count matrix, microarray, etc. |
55+
| Genomic coordinates | `r BiocStyle::Biocpkg("GenomicRanges")` `::GRanges()` | 1-based, closed interval genomic coordinates |
56+
| Genomic coordinates (multiple)| `r BiocStyle::Biocpkg("GenomicRanges")` `::GRangesList()` | Genomic coordinates from multiple samples |
57+
| Ragged genomic coordinates | `r BiocStyle::Biocpkg("RaggedExperiment")` `::RaggedExperiment()` | Ragged (variable length) genomic coordinates |
58+
| DNA/RNA/AA sequences | `r BiocStyle::Biocpkg("Biostrings")` `::*StringSet()` | DNA, RNA, or amino acid sequences |
59+
| Gene sets | `r BiocStyle::Biocpkg("BiocSet")` `::BiocSet()`, <br>`r BiocStyle::Biocpkg("GSEABase")` `::GeneSet()`, <br>`r BiocStyle::Biocpkg("GSEABase")` `::GeneSetCollection()` | Collections of gene sets |
60+
| Multi-omics data | `r BiocStyle::Biocpkg("MultiAssayExperiment")` `::MultiAssayExperiment()` | Data integrating multiple omics assays |
61+
| Single cell data | `r BiocStyle::Biocpkg("SingleCellExperiment")` `::SingleCellExperiment()` | Single-cell expression and related data |
62+
| Mass spec data | `r BiocStyle::Biocpkg("Spectra")` `::Spectra()` | Mass spectrometry data |
63+
| File formats | `r BiocStyle::Biocpkg("BiocIO")` `::BiocFile-class` | Classes for interacting with various biological data file formats |
7264

7365
Search [biocViews][] for other classes and methods that may be useful for your
7466
package.

0 commit comments

Comments
 (0)