Skip to content

Add docs for flex libraries#494

Merged
allyhawkins merged 6 commits intodevelopmentfrom
allyhawkins/flex-docs
Mar 20, 2026
Merged

Add docs for flex libraries#494
allyhawkins merged 6 commits intodevelopmentfrom
allyhawkins/flex-docs

Conversation

@allyhawkins
Copy link
Copy Markdown
Member

@allyhawkins allyhawkins commented Mar 18, 2026

Closes #491

This PR adds in documentation for the 10x flex libraries that are going to be on the Portal soon. I updated the processing information page to include a section on using cellranger multi for GEM-X Flex libraries. To do this I rearranged some of the existing alevin-fry content slightly. Mostly, I wanted to talk about everything specific to alevin-fry all the way through reading in the counts data in one section and then the Flex stuff in a different section. Everything after that is the same regardless of technology.

I also updated the metadata slots in the individual SCEs and merged SCEs to add the new cellranger specific slots (see https://github.com/AlexsLemonade/scpca-nf/blob/fa640c3c86de99a7190264949646e392ed9ecdbb/references/sce-formatting-reference.json#L66-L70). I also denoted which ones were only present if mapping was done with alevin-fry. Lastly, I rearranged the order slightly to group all the alevin-fry specific ones and cellranger multi specific ones together.

@allyhawkins allyhawkins requested a review from sjspielman March 18, 2026 20:55
Comment thread docs/merged_objects.md Outdated
| `af_resolution` | `alevin-fry quant` resolution mode used |
| `usa_mode` | Boolean indicating whether quantification was done using `alevin-fry` USA mode |
| `af_num_cells` | Number of cells reported by `alevin-fry` |
| `mapping_tool` | Pipeline used for mapping and quantification. `alevin-fry` for all tag-based experiments (e.g. 10Xv2, 10Xv3) and `cellranger-multi` for probe-based experiments (GEM-X Flex) |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can neither confirm nor deny that I just spent 3 minutes being really confused why we don't set this for spaceranger too, only to remember we do not make SPEs. That's the other thing I work on (training materials).

Comment thread docs/processing_information.md Outdated

### Mapping and quantification for GEM-X Flex samples

Libraries that were generated using the GEM-X Flex technology from 10x Genomics were quantified with the [`cellranger multi` pipeline](https://www.10xgenomics.com/support/software/cell-ranger/latest/analysis/running-pipelines/cr-multi) within Cell Ranger.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment that applies throughout PR - pick either cellranger multi or cellranger-multi

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that's intentional. We use cellranger-multi as the mapping tool in the object. But the function is noted as cellranger multi on the 10x site. It was kind of bothering me when I was writing this, so I think that's a sign to just change this line in scpca-nf to have the space. https://github.com/AlexsLemonade/scpca-nf/blob/80e7bbb78202ba6cb618feab59af433c750fcdc7/bin/generate_unfiltered_sce_cellranger.R#L164

Co-authored-by: Stephanie J. Spielman <stephanie.spielman@gmail.com>
@allyhawkins
Copy link
Copy Markdown
Member Author

Okay I filed AlexsLemonade/scpca-nf#1234 and now use cellranger multi throughout. This should be ready for another look.

@allyhawkins allyhawkins requested a review from sjspielman March 20, 2026 19:12
Copy link
Copy Markdown
Member

@sjspielman sjspielman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐈‍⬛

@allyhawkins allyhawkins merged commit 873679c into development Mar 20, 2026
5 checks passed
@allyhawkins allyhawkins deleted the allyhawkins/flex-docs branch March 20, 2026 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants