Skip to content

Commit 4b27b75

Browse files
committed
update readme
1 parent 8b69654 commit 4b27b75

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
<a href="https://zenodo.org/badge/latestdoi/611932244"><img src="https://zenodo.org/badge/611932244.svg" alt="DOI"></a>
44

5+
Table of contents:
6+
* [Introduction](#introduction)
7+
* [Getting started](#getting-started)
8+
* [Usage examples](#usage-examples)
9+
* [GEX](#gex)
10+
* [VDJ](#vdj)
11+
* [ADT](#adt)
12+
* [Running parallel jobs with rush](#running-parallel-jobs-with-rush)
13+
14+
## Introduction
15+
516
Here is an R script `saturation.R` for estimating sequencing saturation from a
617
GEX, VDJ, or ADT dataset from the 10x Genomics platform.
718

@@ -114,6 +125,7 @@ Then make a list of input files and pass it to rush:
114125
```bash
115126
ls /project/cellranger_output/*/{molecule_info.h5,all_contig_annotations.csv,*.stat.csv.gz} > files.txt
116127

128+
# Run 16 jobs in parallel, capture outputs from each job in one file
117129
rush -i files.txt -o rush-saturation.txt -j16 'Rscript saturation.R --out out/{/%} --file {}'
118130
```
119131

0 commit comments

Comments
 (0)