galaxyproject / galaxyproject/training-material

Suggestion for Annotating clusters section scrna-seq-basic-pipeline

Open
#2,799 0 comments 0 reactions 0 assignees View on GitHub
transcriptomics
Dominant language
HTML
Stars
367
Forks
1.1k
Avg merge
16h 27m
Merged PRs (30d)
49

Description

Hi,

Firstly thanks to @nomadscientist and others for an excellend scRNAseq processing tutorial in scrna-seq-basic-pipeline. Planning to use it for a workshop.

Had one suggestion around the annotating clusters section. Currently it suggests copying a metatdata column, renaming it, and then adding celltype names. I think this could be simplified by copying the column, using the 'keep original' option in ManipulateAnndata (1.8.1+1+galaxy1). And also adding a note that the cell type order could be different if you have different clustering.

Afraid I don't know enough about the tutorial structure and building e.t.c yet to put this in as a proper pull request. I've put a suggestion for the 'Annotating clusters' section of the markdown (https://github.com/galaxyproject/training-material/blob/main/topics/transcriptomics/tutorials/scrna-seq-basic-pipeline/tutorial.md) below though. In case someone happens to be working on that one?

Low priority.

Thanks!

`
### Annotating Clusters

> ### {% icon hands_on %} Hands-on: Annotating clusters
>
> 1. {% tool [AnnData Operations](toolshed.g2.bx.psu.edu/repos/ebi-gxa/anndata_ops/anndata_ops/1.6.0+galaxy1) %} {% icon tool %} with the following parameters:
> - {% icon param-file %} *"Input object in hdf5 AnnData format"*: `Final object`
> - *"Change field names in AnnData observations"*
> - {% icon galaxy-wf-new %} *"Insert Change field names in AnnData observations"*
> - *"1: Change field names in AnnData observations"*
> - *"Original name"*: `louvain`
> - *"New name"*: `cell_type`
> - *"Keep original"*: {% icon history-share %} `Yes`
> - This makes a copy of the louvain column, which you can change without altering the original
>
> 2. {% tool [Manipulate AnnData](toolshed.g2.bx.psu.edu/repos/iuc/anndata_manipulate/anndata_manipulate/0.7.5+galaxy0) %} with the following parameters:
> - {% icon param-file %} *"Annotated data matrix"*: (output of **AnnData Operations** {% icon tool %})
> - *"Function to manipulate the object"*: `Rename categories of annotation`
> - *"Key for observations or variables annotation"*: `cell_type`
> - *"Comma-separated list of new categories"*: `DP-M1,DP-M2,T-mat,DN,DP-M3,DP-L,DP-M4,RBC,Macrophages`
> - Note that if you have a slightly different clustering, your list of categories might not match. You could have a different number of categories, or they could be in a different order.
>
> 3. **Rename** {% icon galaxy-pencil %} output h5ad `Final cell annotated object`
> - Time to re-plot! {% icon time %} Feel free to re-run {% icon galaxy-refresh %} the **Scanpy PlotEmbed** tool {% icon tool %} on the new object plotting `cell_type` to speed this up. Otherwise...
> 4. {% tool [Scanpy PlotEmbed](toolshed.g2.bx.psu.edu/repos/ebi-gxa/scanpy_plot_embed/scanpy_plot_embed/1.6.0+galaxy0) %} with the following parameters:
> - {% icon param-file %} *"Input object in AnnData/Loom format"*: `Final cell annotated object`
> - *"name of the embedding to plot"*: `umap`
> - *"color by attributes, comma separated texts"*: `cell_type,sex,batch,genotype,Il2ra,Cd8b1,Cd8a,Cd4,Itm2a,Aif1,Hba-a1,log1p_total_counts`
> - *"Field for gene symbols"*: `Symbol`
>
{: .hands_on}
`

Contributor guide

Open the contributing guide

Research direction

Open topics/transcriptomics/tutorials/scrna-seq-basic-pipeline/tutorial.md and locate the Annotating Clusters section. Compare the current instructions with the proposed Markdown in the issue, then check the rendered tutorial and confirm that the referenced Galaxy tool versions and parameters remain valid. Done means the annotation steps and clustering-order caveat are accurately documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.