Skip to content

Commit 257c074

Browse files
docs/content/abismal.md: just very minor updates for clarity
1 parent 57f89ac commit 257c074

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/content/abismal.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# abismal - another bisulfite mapping algorithm
22

33
## Synopsis
4+
45
```console
5-
$ dnmtools abismal [OPTIONS] input.fq [input-r2.fq]
6+
dnmtools abismal [OPTIONS] input.fq [input-r2.fq]
67
```
78

89
# Description
@@ -53,10 +54,13 @@ potential mapping locations for reads that begin with their sequence.
5354
To produce this index run the following command:
5455

5556
```console
56-
$ abismalidx <genome folder or file> <index file>
57+
$ dnmtools abismalidx genome.fa genome.idx
5758
```
5859

59-
For the human genome, whose size is 3 GB, the resulting index is
60+
Where `genome.fa` is the name of your reference genome, and `genome.idx` is
61+
what you decided to name your abismal index file (you can name it anything).
62+
63+
For the human genome hg38 reference, with size 3 GB, the resulting index is
6064
approximately 2.5 GB.
6165

6266
### Decompressing and isolating paired-end reads
@@ -211,10 +215,10 @@ $ mkdir reads_split
211215
$ for i in reads/*.txt; do split -a 3 -d -l 12000000 ${i} reads_split/$(basename $i); done
212216
```
213217

214-
Notice that the number of lines per split file is 12M, since we want
215-
3M reads, and there are 4 lines per read. If you split the reads like
216-
this, you will need to "unsplit" them after the mapping is done. This
217-
can be done using the `samtools merge` command.
218+
Notice that the number of lines per split file is 12M, since we want 3M reads,
219+
and there are 4 lines per read. If you split the reads like this, you will
220+
need to "unsplit" them after the mapping is done. This can be done using the
221+
`samtools merge` command.
218222

219223
Abismal also exists as a standalon program, and more details on
220224
abismal are available in its [documentation

0 commit comments

Comments
 (0)