Skip to content

Commit 6f94e8e

Browse files
committed
update readme
1 parent 0fbf68e commit 6f94e8e

3 files changed

Lines changed: 233 additions & 493 deletions

File tree

README.md

Lines changed: 37 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ No prior experience with single-cell analysis or Bioconductor is required. All c
3434
| R version | 4.3+ | 4.5.2 |
3535
| RStudio | 2023.06+ | Latest |
3636

37-
## Workshop Outline (~3 hours)
37+
## Workshop Outline
38+
39+
### Session 1: Core Single Cell Analysis (Morning, ~3 hours)
3840

3941
| Module | Topic | Duration |
4042
|--------|-------|----------|
@@ -46,6 +48,10 @@ No prior experience with single-cell analysis or Bioconductor is required. All c
4648
| **Module 4** | Differential Expression | 55 min |
4749
| | Wrap-up & Q&A | 10 min |
4850

51+
### Session 2: Downstream Analysis (Afternoon, ~3 hours)
52+
53+
*Coming soon* - Additional downstream analyses using the same heart development dataset.
54+
4955
## Learning Objectives
5056

5157
By the end of this workshop, participants will be able to:
@@ -77,92 +83,61 @@ The workshop uses snRNA-seq data from human heart tissue (Sim et al., 2021):
7783
| Analysis Step | Method | Package |
7884
|--------------|--------|---------|
7985
| Quality control | Per-cell metrics, filtering | Seurat |
80-
| Normalisation | SCTransform v2 | Seurat |
86+
| Normalisation | SCTransform v2 | Seurat, glmGamPoi |
8187
| Batch correction | Harmony | harmony |
8288
| Dimensionality reduction | PCA, UMAP | Seurat |
8389
| Clustering | Louvain algorithm | Seurat |
8490
| Cell type annotation | Marker-based (manual) | Seurat |
8591
| Differential expression | Pseudobulk + limma-voom | edgeR, limma |
8692
| Composition analysis | propeller | speckle |
8793

88-
## Installation
94+
## Quick Start
95+
96+
**Please complete setup at least one day before the workshop.**
97+
98+
1. **Clone or download** this repository
99+
2. **Open** `single_cell_workshop.Rproj` in RStudio
100+
3. **Follow** [Module 0: Setup](https://phipsonlab.github.io/single_cell_workshop/articles/00_setup.html) for detailed instructions
101+
102+
The setup involves:
103+
- Installing packages with `renv::restore()` (~10-15 minutes)
104+
- Downloading data from Zenodo (~420 MB, ~5 minutes)
89105

90-
### Package Versions
106+
## Key Package Versions
91107

92-
This workshop uses pinned package versions for reproducibility. The tutorial outputs were generated with these exact versions:
108+
This workshop uses pinned package versions for reproducibility:
93109

94110
| Package | Version | Package | Version |
95111
|---------|---------|---------|---------|
96112
| R | 4.5.2 | Bioconductor | 3.22 |
97113
| Seurat | 5.4.0 | edgeR | 4.8.2 |
98114
| SeuratObject | 5.3.0 | limma | 3.66.0 |
99115
| harmony | 1.2.4 | speckle | 1.10.0 |
100-
| ggplot2 | 4.0.1 | | |
101-
102-
### Step 1: Install Required Packages
103-
104-
```r
105-
# Install remotes and BiocManager
106-
install.packages(c("remotes", "BiocManager"))
107-
108-
# Set Bioconductor version
109-
BiocManager::install(version = "3.22", ask = FALSE)
110-
111-
# Install Bioconductor packages
112-
BiocManager::install(c(
113-
"edgeR",
114-
"limma",
115-
"org.Hs.eg.db",
116-
"AnnotationDbi",
117-
"speckle"
118-
))
119-
120-
# Install CRAN packages with specific versions
121-
remotes::install_version("Seurat", version = "5.4.0")
122-
remotes::install_version("SeuratObject", version = "5.3.0")
123-
remotes::install_version("harmony", version = "1.2.4")
124-
remotes::install_version("ggplot2", version = "4.0.1")
125-
remotes::install_version("patchwork", version = "1.3.2")
126-
remotes::install_version("dplyr", version = "1.1.4")
127-
remotes::install_version("tidyr", version = "1.3.2")
128-
remotes::install_version("RColorBrewer", version = "1.1.3")
129-
remotes::install_version("clustree", version = "0.5.1")
130-
remotes::install_version("pheatmap", version = "1.0.13")
131-
```
132-
133-
### Step 2: Download Workshop Data
134-
135-
The workshop data (~420 MB) is hosted on Zenodo:
136-
137-
```r
138-
# Download data from Zenodo
139-
zenodo_record <- "18237749"
140-
base_url <- paste0("https://zenodo.org/records/", zenodo_record, "/files/")
141-
142-
dir.create("data", showWarnings = FALSE)
143-
for (f in c("heart-counts.Rds", "cellinfo_updated.Rds")) {
144-
download.file(paste0(base_url, f, "?download=1"), file.path("data", f), mode = "wb")
145-
}
146-
```
147-
148-
### Step 3: Verify Installation
149-
150-
```r
151-
# Check that key packages load correctly
152-
packages <- c("Seurat", "harmony", "edgeR", "limma", "speckle")
153-
sapply(packages, requireNamespace, quietly = TRUE)
154-
```
116+
| glmGamPoi | 1.22.0 | | |
155117

156118
## Workshop Materials
157119

120+
### Session 1: Core Single Cell Analysis
121+
158122
| Module | Topic | Description |
159123
|--------|-------|-------------|
160-
| [Module 0](https://phipsonlab.github.io/single_cell_workshop/articles/00_setup.html) | Setup | Environment setup and package installation |
161-
| [Module 1](https://phipsonlab.github.io/single_cell_workshop/articles/01_quality_control.html) | Quality Control | QC metrics, doublet detection, cell filtering |
124+
| [Module 0](https://phipsonlab.github.io/single_cell_workshop/articles/00_setup.html) | Setup | Environment setup and data download |
125+
| [Module 1](https://phipsonlab.github.io/single_cell_workshop/articles/01_quality_control.html) | Quality Control | QC metrics, cell filtering |
162126
| [Module 2](https://phipsonlab.github.io/single_cell_workshop/articles/02_integration_clustering.html) | Integration | Normalisation, batch correction, clustering |
163127
| [Module 3](https://phipsonlab.github.io/single_cell_workshop/articles/03_cell_type_annotation.html) | Annotation | Marker genes and cell type assignment |
164128
| [Module 4](https://phipsonlab.github.io/single_cell_workshop/articles/04_differential_expression.html) | DE Analysis | Pseudobulk DE and composition analysis |
165129

130+
### Session 2: Downstream Analysis
131+
132+
*Coming soon* - Additional downstream analyses using the same heart development dataset.
133+
134+
<!-- TODO: Add Session 2 modules here when ready
135+
| Module | Topic | Description |
136+
|--------|-------|-------------|
137+
| Module 5 | TBD | TBD |
138+
| Module 6 | TBD | TBD |
139+
-->
140+
166141
## Citation
167142

168143
If you use materials from this workshop, please cite:

_pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ home:
1111
using human heart development snRNA-seq data.
1212
strip_header: true
1313
sidebar:
14-
structure: [links, license, authors]
14+
structure: [links, license]
1515
links:
1616
- text: Original analysis workflow
1717
href: https://bphipson.github.io/Human_Development_snRNAseq/

0 commit comments

Comments
 (0)