Skip to content

Commit c5a1264

Browse files
committed
Updated readme and examples
1 parent cf6a4b5 commit c5a1264

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ Fully supported
1717
- Multiome (joint GEX & ATAC)
1818
- CITE-seq with Biolegend TotalSeq-A/B/C ADTs
1919
- Multiplexing with BioLegend TotalSeq-A/C HTOs
20-
21-
In progress
2220
- Spatial Transcriptomics (Fresh frozen and FFPE)
2321
- Multiplexing with CellPlex
2422

@@ -86,6 +84,8 @@ TotalSeq (to specify which tags/oligos are in use) or Visium to specify image
8684
and probeset paths. For now, just look in `modules/assay-type.nf` to see what
8785
cli options are utilized.
8886

87+
Check out the example samplesheets under the `examples` directory.
88+
8989
### Things not to do:
9090
- No YAML multipage documents
9191

@@ -112,6 +112,7 @@ cli options are utilized.
112112
| | 6.0.1 | |
113113
| | 6.0.2 | |
114114
| | 6.1.1 | |
115+
| | 7.0.0 | |
115116
| CellRanger ATAC | 1.1.0 | do not use, barcode doublet issue |
116117
| | 1.2.0 | |
117118
| | 2.0.0 | |
@@ -123,6 +124,7 @@ cli options are utilized.
123124
| | 1.2.0 | |
124125
| | 1.2.2 | |
125126
| | 1.3.0 | |
127+
| | 2.0.0 | |
126128

127129
## Testing
128130

examples/biolegend.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- {libraries: [SC2200111], sample_name: my-gex-lib, library_types: [Gene Expression], tool: cellranger, tool_version: 6.1.2, command: count, is_nuclei: false, reference_path: /path/to/10x-rna/refdata-gex-GRCh38-2020-A, fastq_paths: [path/to/fastq/files], n_cells: 15000}
2+
- {libraries: [SC2200222], sample_name: my-hto-lib, library_types: [TotalSeq-A], tool: citeseq-count, tool_version: 1.4.5, command: , fastq_paths: [/path/to/fastq/files], tags: ["A0251", "A0252", "A0253", "A0254", "A0255", "A0256"], n_cells: 30000}

examples/visium.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- { libraries: [SC2200581], sample_name: frozen-visium, library_types: [Spatial Gene Expression], slide: V12A34-567, area: A1, image: /path/to/brightfield/image.tiff, roi_json: /path/to/image/metadata.json, tool: spaceranger, tool_version: 1.3.1, command: count, reference_path: /path/to/10x-rna/refdata-gex-mm10-2020-A, fastq_paths: [/path/to/fastq/files]}
2+
- { libraries: [SC2200682], sample_name: ffpe-visium, library_types: [Spatial Gene Expression], slide: V12X23-345, area: D1, image: path/to/brightfield/image.tiff, roi_json: /path/to/image/metadata.json, tool: spaceranger, tool_version: 1.3.1, command: count, probe_set: 1.3.0/Visium_Human_Transcriptome_Probe_Set_v1.0_GRCh38-2020-A.csv, reference_path: /path/to/10x-rna/refdata-gex-GRCh38-2020-A, fastq_paths: [/path/to/fastq/files]}

0 commit comments

Comments
 (0)