Skip to content

Commit abe39f2

Browse files
docs/content/format.md: adding a description of the argument for when input is strict SAM format
1 parent 257c074 commit abe39f2

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/content/format.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,20 @@ into a single entry. SAM/BAM files generated by abismal, Bismark and
1919
BSMAP can be formatted using the `format` command.
2020

2121
An example use of this command to format a mapped reads file is:
22-
```shell
23-
$ dnmtools format -f abismal input.bam output.sam
22+
23+
```console
24+
dnmtools format -f abismal input.bam output.sam
2425
```
26+
2527
Above, the file `input.sam` would have been generated by `abismal`.
2628
The file `output.bam` is the output, and an output file is required
2729
here unless the `-stdout` argument is specified (see below). Another
2830
example:
29-
```shell
30-
$ dnmtools format -f abismal -t 8 -B input.bam output.bam
31+
32+
```console
33+
dnmtools format -f abismal -t 8 -B input.bam output.bam
3134
```
35+
3236
This will use 8 threads because of the `-t 8` and will produce output
3337
in BAM format because of the `-B` flag (not the filename of the
3438
output).
@@ -94,6 +98,13 @@ unlimited). Normally this parameter is determined during read mapping,
9498
but `format` can also reject reads that are in opposing strands in the
9599
same chromosome but map more than this many bases apart.
96100

101+
```txt
102+
-S, -sam
103+
```
104+
The input follows SAM standards for orientation, where reads that map to the
105+
reverse complement of the reference genome are stored as their reverse
106+
complement in the SAM/BAM file.
107+
97108
```txt
98109
-F, -force
99110
```

0 commit comments

Comments
 (0)