Skip to content

Commit 4d59b3e

Browse files
committed
readme: Sync usages
1 parent 9d251ca commit 4d59b3e

File tree

1 file changed

+12
-31
lines changed

1 file changed

+12
-31
lines changed

README.md

+12-31
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ times aligned records intersect known gene annotations.
3636
```
3737
Gene expression quantification
3838
39-
Usage: squab quantify [OPTIONS] --output <OUTPUT> --annotations <ANNOTATIONS> <BAM>
39+
Usage: squab quantify [OPTIONS] --annotations <ANNOTATIONS> <SRC>
4040
4141
Arguments:
42-
<BAM> Input alignment file
42+
<SRC> Input alignment file
4343
4444
Options:
4545
--with-secondary-records
@@ -57,13 +57,13 @@ Options:
5757
--min-mapping-quality <MIN_MAPPING_QUALITY>
5858
[default: 10]
5959
-o, --output <OUTPUT>
60-
Output destination for feature counts
60+
Output destination
6161
-a, --annotations <ANNOTATIONS>
6262
Input annotations file (GFF3)
6363
--threads <THREADS>
6464
Force a specific number of threads
6565
-h, --help
66-
Print help information
66+
Print help (see more with '--help')
6767
```
6868

6969
The default output is a tab-delimited text file with two columns: the feature
@@ -84,37 +84,18 @@ using `squab quantify` or `htseq-count`.
8484
```
8585
Normalize features counts
8686
87-
Usage: squab normalize [OPTIONS] --annotations <ANNOTATIONS> <COUNTS>
87+
Usage: squab normalize [OPTIONS] --annotations <ANNOTATIONS> <SRC>
8888
8989
Arguments:
90-
<COUNTS>
91-
Input counts file
90+
<SRC> Input counts file
9291
9392
Options:
94-
-t, --feature-type <FEATURE_TYPE>
95-
Feature type to count
96-
97-
[default: exon]
98-
99-
-i, --id <ID>
100-
Feature attribute to use as the feature identity
101-
102-
[default: gene_id]
103-
104-
-a, --annotations <ANNOTATIONS>
105-
Input annotations file (GFF3)
106-
107-
--method <METHOD>
108-
Quantification normalization method
109-
110-
[default: tpm]
111-
112-
Possible values:
113-
- fpkm: fragments per kilobase per million mapped reads
114-
- tpm: transcripts per million
115-
116-
-h, --help
117-
Print help information (use `-h` for a summary)
93+
-t, --feature-type <FEATURE_TYPE> Feature type to count [default: exon]
94+
-i, --id <ID> Feature attribute to use as the feature identity [default: gene_id]
95+
-a, --annotations <ANNOTATIONS> Input annotations file (GFF3)
96+
--method <METHOD> Quantification normalization method [default: tpm] [possible values: fpkm, tpm]
97+
-o, --output <OUTPUT> Output destination
98+
-h, --help Print help (see more with '--help')
11899
```
119100

120101
The output is a tab-delimited text file with two columns: the feature

0 commit comments

Comments
 (0)