From 2de16a9bb3703a3119a3c471710501451ea58238 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sara=20Jim=C3=A9nez?= Date: Thu, 7 Nov 2024 16:48:33 +0100 Subject: [PATCH] Update index.md --- notebooks/index.md | 67 ++++++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 32 deletions(-) diff --git a/notebooks/index.md b/notebooks/index.md index b5559f3..7b877a0 100644 --- a/notebooks/index.md +++ b/notebooks/index.md @@ -1,42 +1,45 @@ -# Single-cell analysis template repository +# GSCN workshop 2024 -This repository acts as a template notebook for the analysis of single-cell data and methods; the corresponding Jupyter -Book is rendered [here](https://github.com/sarajimenez/GSCN_workshop_2024). -You can check the [CellRank 2 reproducibility repository](https://github.com/theislab/cellrank2_reproducibility) -for an example repository following the same outline as this template. +This repository is a collection of tutorials presented during the [GSCN workshop 2024 ‘Computational single cell genomics for stem cell biologists’](https://www.gscn.org/conferences-events/gscn-events/working-group-workshops) - November 7-8, 2024. -## Set up +The corresponding Jupyter Book is rendered [here](https://sarajimenez.github.io/GSCN_workshop_2024/). -1. Rename `src/fancypackage/`. -2. Update `pyproject.toml` to include the correct information - - Project name - - Project description - - Project-specific Python requirements - - Project author - - Project maintainers - - Project URLs -3. Update `src/fancypackage/core/_constants.py` to include any paths relevant to your analysis and that should be accessible from any script or Jupyter notebook -4. Update this README to include the relevant information about your project. -5. Ensure repository settings are set up correctly to build Jupyter Book: - - In `Settings > Actions > General > Workflow permissions`: Allow read and write permissions. - - In `Settings > Pages > Build and deployment`: Set the branch to `gh-pages`. +## Table of Contents -## Installation +- [Material](#Material) +- [Session-1](#Session-1) +- [Session-2](#Session-2) +- [Session-3](#Session-3) +- [Session-4](#Session-4) -```bash -conda create -n fancyname-pyXX python=X.X --yes && conda activate fancyname-pyXX -pip install -e ".[dev]" -pre-commit install +## Material -pip install jupyterlab ipywidgets -python -m ipykernel install --user --name fancyname-pyXX --display-name "fancyname-pyXX" -``` +The data for each session can be found [here](https://drive.google.com/drive/folders/1mD36tCwFMJ5g4Fh5p5nptDXy_ObmK7ww?usp=sharing). +Material for the workshop has been adapted from the [single-cell best practices book](https://www.sc-best-practices.org/preamble.html), a live project from the Theis lab. +Recordings of previous single-cell RNA seq data analysis workshops can be found [here](https://www.youtube.com/playlist?list=PL4rcQcNPLZxWQQH7LlRBMkAo5NWuHX1e3). -## Things to keep in mind -Whenever you use a new single-cell tool, add it to `known_bio` in `pyproject.toml` s.t. `isort` can work correctly. +## Session-1 -## Workflow +1. Preprocessing and Quality Control (QC) +2. Data normalization -The workflow for committing a notebook is as follows: Upon committing a notebook, the pre-commit hooks format your notebook -and generate a corresponding script. You need to add the formatted notebook and Python script to the same commit for the commit to go through. The commit will now either be successful or not. If not, your Python script was formatted by the pre-commit hooks. In that case, you need to update your notebook accordingly, unstage the Python script, and recommit the notebook. You will iterate through this process until there are no inconsistencies between the notebook and its corresponding Python script. +## Session-2 + +1. Dimensionality reduction +2. Clustering and annotation +3. DGE + +## Session-3 + +1. Trajectory analysis +2. Multisample analysis + +## Session-4 + +1. Introduction to spatial transcriptomics + +## Acknowledments + +Special thanks to the scverse community (especially the developers and the maintainers of scanpy and squidpy packages) and all the Theis lab for valuable contributions. +Huge thanks also go to [Roshan Sharma](https://www.mskcc.org/research/ski/labs/members/roshan-sharma) from Dana Pe'er's lab for kindly providing material for the workshop.