Skip to content

Commit ca4aa04

Browse files
committed
additional improvements
- convert list to table
1 parent 77a04c4 commit ca4aa04

File tree

1 file changed

+19
-27
lines changed

1 file changed

+19
-27
lines changed

bioc-classes-methods.Rmd

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
Bioconductor is a large and diverse project with many packages that provide
66
functionality for a wide range of biological data types and statistical methods.
77
It has a rich set of classes and methods that are widely used across
8-
many packages. It, therefore, is important to reuse existing data classes and
8+
many packages. It is, therefore, important to reuse existing data classes and
99
methods to ensure that packages are inter-operable with the rest of the
10-
_Bioconductor_ ecosystem. Central data representations allow users to readily
11-
integrate analysis workflows across multiple Bioconductor packages providing a
12-
more seamless user experience.
10+
_Bioconductor_ software ecosystem. Central data representations allow users to
11+
readily integrate analysis workflows across multiple Bioconductor packages
12+
providing a more seamless user experience.
1313

1414
Many classes in Bioconductor are implemented using the S4 object-oriented
1515
system in R. The S4 system is particularly well-suited for the representation
16-
of complex genomic data structures and the initial motivations to use S4 in
16+
of complex genomic data structures. The initial motivations to use S4 in
1717
Bioconductor were centered around its benefits over other systems such as S3.
1818
These benefits include, but are not limited to, formal class definitions,
1919
multiple inheritance, and validity checking.
@@ -41,12 +41,12 @@ commonly used packages and their methods to import various data types:
4141
This list is not exhaustive, and developers are encouraged to initiate dialogue
4242
with other community members to identify additional packages and methods that
4343
may be useful for their specific use case. We acknowledge that class and method
44-
discover-ability can be a challenge and we are working to improve this aspect of
44+
discoverability can be a challenge and we are working to improve this aspect of
4545
the Bioconductor project.
4646

4747
### Common Classes {#commonclass}
4848

49-
The following list, though not exhaustive, provides select classes and
49+
The following list, though certainly not exhaustive, provides select classes and
5050
constructor functions to represent genomic data:
5151

5252
+ Rectangular feature x sample data --
@@ -75,32 +75,24 @@ package.
7575

7676
## Package Submission Considerations
7777

78-
Bioconductor strives for interoperability across packages. To ensure this, we
79-
strongly encourage that package submissions reuse existing Bioconductor classes
80-
and methods. Packages that do not follow this guideline may be asked to revise
78+
Bioconductor strives for interoperability across packages and strongly
79+
encourages that package submissions reuse existing Bioconductor classes and
80+
methods. Packages that do not follow this guideline may be asked to revise
8181
their code to use existing classes and methods.
8282

8383
In the case where the data does not conform to an existing data class,
8484
we recommend discussing the design of a new class with the Bioconductor
8585
community. The open discussion can take place on main Bioconductor communication
8686
channels such as the [bioc-devel][bioc-devel-mail] mailing list, or the
87-
Bioconductor slack.
87+
Bioconductor community slack.
8888

8989
## Package Implementations
9090

91-
The following packages are examples of packages that have reused Bioconductor
92-
classes and methods:
93-
94-
+ `r BiocStyle::Biocpkg("DESeq2")` --
95-
Uses `r BiocStyle::Biocpkg("SummarizedExperiment")` and
96-
`r BiocStyle::Biocpkg("GenomicRanges")`
97-
+ `r BiocStyle::Biocpkg("GenomicAlignments")` --
98-
Uses `r BiocStyle::Biocpkg("GenomicRanges")` and
99-
`r BiocStyle::Biocpkg("Rsamtools")`
100-
+ `r BiocStyle::Biocpkg("VariantAnnotation")` --
101-
Uses `r BiocStyle::Biocpkg("GenomicRanges")`,
102-
`r BiocStyle::Biocpkg("SummarizedExperiment")`, and
103-
`r BiocStyle::Biocpkg("Rsamtools")` classes.
104-
105-
106-
91+
The following packages are examples of packages that reuse Bioconductor classes
92+
and methods:
93+
94+
| package | inherits classes and methods from: |
95+
|---|---|
96+
| `r BiocStyle::Biocpkg("DESeq2")` | `r BiocStyle::Biocpkg("SummarizedExperiment")`, `r BiocStyle::Biocpkg("GenomicRanges")` |
97+
| `r BiocStyle::Biocpkg("GenomicAlignments")` | `r BiocStyle::Biocpkg("GenomicRanges")`, `r BiocStyle::Biocpkg("Rsamtools")` |
98+
| `r BiocStyle::Biocpkg("VariantAnnotation")` | `r BiocStyle::Biocpkg("GenomicRanges")`, `r BiocStyle::Biocpkg("SummarizedExperiment")`, `r BiocStyle::Biocpkg("Rsamtools")` |

0 commit comments

Comments
 (0)