Skip to content

Commit ccb857f

Browse files
committed
Tidy homepage
1 parent 1bf6391 commit ccb857f

File tree

2 files changed

+86
-98
lines changed

2 files changed

+86
-98
lines changed

README.md

Lines changed: 36 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
# The Bioconductor training committee
1+
# The Bioconductor Training Committee
22

3-
The Bioconductor training committee is a collaborative effort to
4-
consolidate Bioconductor-focused training material and establish
5-
a community of Bioconductor trainers. We define a curriculum and
6-
implement online lessons for beginner and more advanced R users
7-
who want to learn to analyse their data with Bioconductor packages.
3+
The Bioconductor Training Committee is a collaborative effort to consolidate Bioconductor-focused training material and build a global community of instructors. We define curricula and develop lessons for both beginner and more advanced R users who want to analyse their data with Bioconductor packages.
84

9-
The Bioconductor training committee reports to the Bioconductor
10-
[Community Advisory Board](http://bioconductor.org/about/community-advisory-board/).
11-
It is currently chaired by Charlotte Soneson and Laurent Gatto.
12-
There’s no formal joining process or minimum commitment required — simply attend one of the monthly meetings (announced on the Google group, see below) or engage in our discussions to become a part of our community.
5+
The committee reports to the Bioconductor
6+
[Community Advisory Board](https://bioconductor.org/about/community-advisory-board/) and is currently chaired by [Charlotte Soneson](https://csoneson.github.io/) and [Laurent Gatto](https://lgatto.codeberg.page/).
137

14-
This meta-repository is used for general discussions. The respective
15-
lessons are developed as modules in their own repositories.
8+
There's no formal joining process and no minimum commitment required - simply attend one of our monthly meetings (announced on the Google group below) or join the conversation to become part of the community.
9+
10+
- [Monthly meeting link](https://meet.jit.si/BioconductorTeaching)
11+
- [Rolling agenda & notes (Google Doc)](https://docs.google.com/document/d/1s2QMk5XA-uhBVprAO3ZDk1Yfv1cnUWLp9zdvYq9Feu4/edit#)
12+
- [Google group](https://groups.google.com/g/bioconductor-teaching/) (announcements & reminders)
13+
- [Bioconductor Chat](https://chat.bioconductor.org): `#education-and-training` channel
1614

1715
## Publications
1816

@@ -22,110 +20,50 @@ Published in *PLOS Computational Biology*
2220

2321
👉 [Read the full paper](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1012925)
2422

25-
## Modules
2623

27-
- [bioc-intro](https://carpentries-incubator.github.io/bioc-intro/)
28-
The **Data science** lesson is based on the [Carpentries Ecology
29-
Curriculum](https://datacarpentry.org/lessons/#ecology-workshop). There
30-
are no pre-requisites for this module, and the materials assume no
31-
prior knowledge about R and Bioconductor. It introduces R, RStudio,
32-
teaches data cleaning, management, analysis, and visualisation and
33-
introduces some Bioconductor concepts. Notes are collated in
34-
`bioc-intro.md` in this repo.
24+
## Training Modules
25+
26+
Bioconductor Carpentry lessons developed by the training committee are organised into modules, each designed for specific audiences and skill levels.
3527

28+
- [bioc-intro](https://carpentries-incubator.github.io/bioc-intro/)
29+
An introduction to R, RStudio, data cleaning, management, analysis, and visualisation, based on the Carpentries Ecology curriculum.
30+
No prior experience required. Includes introductory Bioconductor concepts.
3631
- [bioc-rnaseq](https://carpentries-incubator.github.io/bioc-rnaseq/)
37-
**Analysis and interpretation of bulk RNA sequencing data with
38-
Bioconductor** shows how to use Bioconductor packages to analyse
39-
bulk RNA-seq data. It expects good familiarity with R and the
40-
Bioconductor project.
32+
Bulk RNA-seq analysis and interpretation with Bioconductor packages.
33+
Requires good familiarity with R and Bioconductor.
4134

4235
- [bioc-scrnaseq](https://carpentries-incubator.github.io/bioc-scrnaseq/)
43-
**Analysis and interpretation of single-cell RNA sequencing data with
44-
Bioconductor** shows how to use Bioconductor packages for essential single-cell
45-
analysis steps including quality control, cell type annotation, multi-sample
46-
analysis, working with large data, and integration with public data.
47-
Pre-requisites include familiarity with R and Bioconductor. Familiarity with
48-
bulk RNA-seq data analysis is beneficial, but not strictly required.
36+
Single-cell RNA-seq analysis with Bioconductor, covering QC, cell type annotation, multi-sample workflows, large datasets, and integration with public data.
37+
Requires R/Bioconductor familiarity; bulk RNA-seq experience helpful but optional.
4938

5039
- [bioc-project](https://carpentries-incubator.github.io/bioc-project/)
51-
The **Bioconductor project** lesson provides an introduction to the
52-
Bioconductor project such as the Bioconductor home page, packages,
53-
package landing pages, and package vignettes, where to find help,
54-
Bioconductor workflows, Bioconductor release schedule and versions,
55-
some core infrastructure, ... It is meant to be use in combination
56-
with other modules as part of a wider workshop.
40+
An overview of the Bioconductor project: website, packages, landing pages, vignettes, workflows, release cycles, and infrastructure.
41+
Designed to be combined with other modules during workshops.
42+
5743

5844
### New lessons
5945

60-
If you are interested in contributing new lessons or Carpentry modules,
61-
feel free to get in touch with the teaching committee via Zulip or the
62-
google group (see below). We would be happy to discuss and/or contribute
63-
to anything related to the lesson design, general help with the long-term
64-
maintenance, dissemination of the lesson, or any help/topic you can think of.
65-
66-
## Material design and maintenance
67-
68-
### Lesson design
69-
70-
- Use RStudio for teaching.
71-
- If possible, finish lessons with a *Next steps* section to highlight
72-
other relevant Bioconductor lessons. Similarly, in the Summary and
73-
Setup section, refer to other Bioconductor lessons that cover the
74-
pre-requisites.
75-
- Whenever relevant, use Bioconductor recommended/maintained classes.
76-
- Package installation: favour `BiocManager::install()` for all
77-
packages.
78-
- The bioc-intro lesson, which is based on the Ecology lesson, focuses
79-
on the tidyverse.
80-
81-
### Maintenance
82-
83-
**Maintenance team** Each Bioconductor lesson has at least one
84-
maintainer, and more generally a team of instructors that built and
85-
adviser on the maintenance of the lesson collaboratively. The
86-
maintainer is the person that takes responsibility for merging the PRs
87-
and fixing build issues if/when they happen. The Carpentries
88-
Curriculum Advisory Committee Consultation Rubric provides a template
89-
as to how to address changes to the lessons.
90-
91-
**Contributing and handling minor changes** For minor changes such as
92-
typos or simple rephrasing can be submitted directly through a Github
93-
pull request. The lesson maintainer can assess the PR, ask for
94-
clarifications or amendments and eventually merge the pull request.
95-
96-
**Contributing and handling big changes** For more substantial changes,
97-
we advise to first open an issue to discuss these changes with the
98-
maintainer, the team that created the lesson, and other instructors
99-
that have experience teaching the episode. A pull request for such a
100-
more substantial change (and here, we deliberately don’t define them
101-
explicitly and leave it to the lesson maintainer to assess the
102-
importance), would be discussed in (1) the Github pull request and/or
103-
(2) on the bioconductor-teaching google group and/or, if necessary (3)
104-
during a Bioconductor teaching monthly meeting. For the latter, it
105-
would be recommended that at least 2 to 3 people that were part in the
106-
design of the lesson and/or that have teaching experience would be
107-
present in addition to the lesson maintainer. The PR submitter is also
108-
welcome to join the discussion.
46+
Interested in contributing a new lesson or adapting a Carpentry-style module?
47+
We’d be happy to discuss ideas, lesson design, long-term maintenance, dissemination, or any support you may need.
10948

49+
- Contact us via [Bioconductor Chat](https://chat.bioconductor.org/)
50+
- View our contributor documentation: [Lesson Design & Maintenance Guidelines](collaborations/carpentries/lesson-guidelines.qmd)
11051

11152
## Notes and meetings
11253

11354
- [Governance document](resources/bioc-training-governance-v1.0.0.pdf)
114-
- Collaborative [Google
115-
doc](https://docs.google.com/document/d/1s2QMk5XA-uhBVprAO3ZDk1Yfv1cnUWLp9zdvYq9Feu4/edit#).
116-
117-
## Discussions
118-
119-
- The `education-and-training` channel on the [Bioconductor community
120-
chat](https://chat.bioconductor.org/).
121-
- The [Google group](https://groups.google.com/g/bioconductor-teaching/) (low-traffic, mainly used to send a reminder for the monthly meeting).
55+
- Community discussions: education-and-training channel on [Bioconductor Chat](https://chat.bioconductor.org/).
56+
- [Google group](https://groups.google.com/g/bioconductor-teaching/): low-traffic, used for monthly meeting reminders
12257

12358
## Events
12459

125-
Explore upcoming opportunities and past Bioconductor workshops and training sessions on our [events page](https://www.bioconductor.org/help/events/). Interested in sharing your own Bioconductor training event with the community? Learn how to add your event directly through this page.
60+
Explore upcoming and past Bioconductor workshops on our [workshops](https://training.bioconductor.org/workshops/index.html) and [events](https://www.bioconductor.org/help/events/) pages.
12661

12762
## Contact
12863

129-
If you are interested in this project and want to get in touch or
130-
participate, please contact the group via the Google group or
131-
individual members on [Bioconductor Chat](https://chat.bioconductor.org) or by email.
64+
If you’re interested in joining, contributing, or simply learning more, please contact us via:
65+
66+
- The `#education-and-training` channel, or committee co-chairs on [Bioconductor Chat](https://chat.bioconductor.org) or by email
67+
- Or drop into one of our monthly meetings
68+
69+
We look forward to welcoming you into the Bioconductor training community!
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Lesson Design & Maintenance Guidelines"
3+
editor: visual
4+
---
5+
6+
This page provides guidance for contributors, instructors, and maintainers involved in developing and sustaining Bioconductor training materials. It consolidates expectations, best practices, and processes across all Bioconductor training modules.
7+
Our goal is to ensure that lessons remain high‑quality, accessible, consistent, and easy for the community to maintain.
8+
9+
## Lesson design
10+
11+
- Use RStudio for teaching.
12+
- If possible, finish lessons with a *Next steps* section to highlight
13+
other relevant Bioconductor lessons. Similarly, in the Summary and
14+
Setup section, refer to other Bioconductor lessons that cover the
15+
pre-requisites.
16+
- Whenever relevant, use Bioconductor recommended/maintained classes.
17+
- Package installation: favour `BiocManager::install()` for all
18+
packages.
19+
- The bioc-intro lesson, which is based on the Ecology lesson, focuses
20+
on the tidyverse.
21+
22+
## Maintenance
23+
24+
**Maintenance team** Each Bioconductor lesson has at least one
25+
maintainer, and more generally a team of instructors that built and
26+
adviser on the maintenance of the lesson collaboratively. The
27+
maintainer is the person that takes responsibility for merging the PRs
28+
and fixing build issues if/when they happen. The Carpentries
29+
Curriculum Advisory Committee Consultation Rubric provides a template
30+
as to how to address changes to the lessons.
31+
32+
**Contributing and handling minor changes** For minor changes such as
33+
typos or simple rephrasing can be submitted directly through a Github
34+
pull request. The lesson maintainer can assess the PR, ask for
35+
clarifications or amendments and eventually merge the pull request.
36+
37+
**Contributing and handling big changes** For more substantial changes,
38+
we advise to first open an issue to discuss these changes with the
39+
maintainer, the team that created the lesson, and other instructors
40+
that have experience teaching the episode. A pull request for such a
41+
more substantial change (and here, we deliberately don’t define them
42+
explicitly and leave it to the lesson maintainer to assess the
43+
importance), would be discussed in (1) the Github pull request and/or
44+
(2) on the bioconductor-teaching google group and/or, if necessary (3)
45+
during a Bioconductor teaching monthly meeting. For the latter, it
46+
would be recommended that at least 2 to 3 people that were part in the
47+
design of the lesson and/or that have teaching experience would be
48+
present in addition to the lesson maintainer. The PR submitter is also
49+
welcome to join the discussion.
50+

0 commit comments

Comments
 (0)