Skip to content

Commit 8f8cbb9

Browse files
committed
docs: extend and clarify explanations in config/README.md
1 parent 981d690 commit 8f8cbb9

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

config/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
## Workflow overview
22

33
This workflow is a best-practice workflow for systematically running `cellranger count` on one or more samples.
4+
See the [10X documentation choosing a pipeline](https://www.10xgenomics.com/support/software/cell-ranger/latest/analysis/running-pipelines/cr-choosing-a-pipeline) to see whether this is the preprocessing you need.
5+
If your assay setup suggests `cellranger multi`, have a look at the [standardised workflow for `cellranger multi` instead](https://snakemake.github.io/snakemake-workflow-catalog/docs/workflows/snakemake-workflows/cellranger-multi).
6+
47
The workflow is built using [snakemake](https://snakemake.readthedocs.io/en/stable/) and consists of the following steps:
58

69
1. Link in files to a new file name that follows cellranger requirements.
710
2. Create a per-sample cellranger library CSV sheet.
8-
3. Run cellranger count, parallelizing over samples.
11+
3. Run `cellranger count`, parallelizing over samples.
912
4. Create a snakemake report with the Web Summaries.
1013

1114
## Running the workflow
@@ -27,15 +30,17 @@ With this environment variable set, the workflow will automatically install `cel
2730

2831
The sample sheet has the following layout:
2932

30-
| sample | lane_number | library_type | read1 | read2 |
31-
| ------- | ----------- | --------------- | ------------------------------- | ------------------------------- |
32-
| sample1 | 1 | Gene Expression | sample1.bwa.L001.read1.fastq.gz | sample1.bwa.L001.read2.fastq.gz |
33-
| sample1 | 2 | Gene Expression | sample1.bwa.L002.read1.fastq.gz | sample1.bwa.L002.read2.fastq.gz |
34-
| sample2 | 1 | Gene Expression | sample2.bwa.read1.fastq.gz | sample2.bwa.read2.fastq.gz |
33+
| sample | lane_number | library_type | read1 | read2 |
34+
| ------- | ----------- | --------------- | --------------------------------------- | --------------------------------------- |
35+
| sample1 | 1 | Gene Expression | ../data/sample1.bwa.L001.read1.fastq.gz | ../data/sample1.bwa.L001.read2.fastq.gz |
36+
| sample1 | 2 | Gene Expression | ../data/sample1.bwa.L002.read1.fastq.gz | ../data/sample1.bwa.L002.read2.fastq.gz |
37+
| sample2 | 1 | Gene Expression | ../data/sample2.bwa.read1.fastq.gz | ../data/sample2.bwa.read2.fastq.gz |
38+
39+
The `lane_number` column is optional, and only necessary if a single sample is sequenced across multiple lanes.
40+
All other columns are required:
3541

36-
The `lane_number` column is optional, and only necessary if a any sample is sequenced across multiple lanes.
37-
All other columns are required.
38-
`read1` and `read2` require relative paths to the main workflow directory (where you run the `snakemake` command).
42+
* `library_type` can be any of the [values listed in the `cellranger count` documentation on Library CSVs](https://www.10xgenomics.com/support/software/cell-ranger/latest/analysis/inputs/cr-libraries-csv).
43+
* `read1` and `read2` require file names with paths relative to the main workflow directory (where you run the `snakemake` command).
3944

4045
### Parameters
4146

0 commit comments

Comments
 (0)