Skip to content

Commit

Permalink
Update gene_list_format.md
Browse files Browse the repository at this point in the history
  • Loading branch information
giuliaelgarcia authored Apr 16, 2024
1 parent 7e1ddf3 commit 0935a7e
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/usage/gene_list_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,33 @@ minimal:
Generally in the visualization pipeline all gene groups in the input are plotted. In heatmaps and dotplots, one dotplot per group is plotted. For UMAPs, one plot per gene is
plotted, and a new file is saved per group.


## Plot Makers in the Visualization workflow

The custom maker csv file for full and minimal must contain three columns and follow the following structure:
| mod | feature | group |
|------|----------|--------------|
| prot | prot_CD8 | Tcellmarkers |
| rna | CD8A | Tcellmarkers |

The full list will be plotted in dot plots and matrix plots, with one plot per group.

The shorter list will be plotted on umaps as well as other plot types, with one plot per group.

| feature_1 | feature_2 | colour |
|-----------|-----------|----------------|
| CD8A | prot_CD8 | |
| CD4 | CD8A | doublet_scores |



## Plot metadata variables
The scatter_features.csv file should have the following format:

| feature_1 | feature_2 | colour |
|-----------|-----------|----------------|
|rna:total_counts | prot:total_counts | doublet_scores

## Final notes

Be deliberate and informative with the choice of group names for any gene set use, since the `.obs` column generated as output will be named based on the group of the gene list input file.
Expand Down

0 comments on commit 0935a7e

Please sign in to comment.