Skip to content

Commit 2da0f55

Browse files
bsrate.md: updating documentation for features in v1.4.0
1 parent 5659176 commit 2da0f55

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/content/bsrate.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,42 @@ Use only reads that map to this chromosome (e.g. chrM). This simply
136136
avoids having to extract reads separately from the mapped reads file
137137
before using bsrate.
138138

139+
```txt
140+
-A, -a-rich
141+
```
142+
The reads are A-rich. This may be relevant if a BPAT protocol is used.
143+
139144
```txt
140145
-v, -verbose
141146
```
142147
Print more information while the program is running.
148+
149+
```txt
150+
-S, -summary
151+
```
152+
Write the analysis summary to this file. The summary is not reported
153+
unless a file is specified here. This information includes nothing
154+
beyond what is currently generated for the output file. This option is
155+
correct as of v1.4.0.
156+
157+
```txt
158+
-t, -threads
159+
```
160+
Use this many threads. This only has an effect if set to a value
161+
greater than 1. The additional threads are only used for decompressing
162+
BAM format input. It is not recommended to use many threads due to
163+
diminishing returns, and performance will degrade if more threads are
164+
specified than physical cores available. This option is correct as of
165+
v1.4.0.
166+
167+
```txt
168+
-p, -per-read
169+
```
170+
This option will generate a histogram of conversion rate per read,
171+
printed to the terminal. This option is correct as of v1.4.0.
172+
173+
```txt
174+
-p, -per-read
175+
```
176+
Assming the `-p` option is used, this option determines the number of
177+
bins in the histogram. This option is correct as of v1.4.0.

0 commit comments

Comments
 (0)