Skip to content

Commit 5f8ab42

Browse files
committed
update readme
1 parent 2033945 commit 5f8ab42

2 files changed

Lines changed: 25 additions & 3 deletions

File tree

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ The output is ordered in the same as reads appear in the input BAM file. First c
271271
canonical_base(character such as ACGTN)|mod_code(character or ChEBI number)|status_flag(. or ?)
272272
```
273273
274-
Status flag describes how skipped bases (not included in the output of view or freq subtools) should be interpreted by downstream tools.
274+
Status flag describes how skipped bases should be interpreted by downstream tools.
275275
- **.** : skipped bases should be assumed to have low probability of modifications.
276276
- **?** : there is no information about the modification status of skipped bases
277277
@@ -319,7 +319,29 @@ If the context is not specified in square brackets along with modification code,
319319
| N | n | Xao | Xanthosine | N |
320320
| N | N | | Ambiguity code; any mod | N |
321321
322-
Note that we have done a lot of testing on 5mc and some limited testing on 6mA and 5hmC. The others are not yet tested.
322+
## Supported and tested modifications
323+
324+
Minimod is expected to support standard modifications given in the table above and any other either given as modification code or ChEBI code in MM tag of the BAM record.
325+
Note that we have done a lot of testing on 5mC and some limited testing on 6mA and 5hmC. The others are not thoroughly tested. Following is a summary of tests we have performed.
326+
327+
| DNA/RNA | mod+base called model | aligned to | tested modification[context] combinations |
328+
| - | - | - | - |
329+
| DNA | 5mCG_5hmCG | hg38 genome | m[CG], h[CG], m[C], h[C], m[any], any[any] |
330+
| DNA | 4mC_5mC | hg38 genome | m[CG], m[C], 21839[C], any[any] |
331+
| DNA | 5mC_5hmC | hg38 genome | m[CG], h[CG], m[C], h[C], m[any], any[any] |
332+
| DNA | 6mA | hg38 genome | a[A], a[any], any[any] |
333+
| RNA | 2OmeG | hg38 genome | 19229[G], 19229[any], any[any] |
334+
| RNA | inosine_m6A_2OmeA | hg38 genome | 69426[A], a[A], 17596[A], any[any] |
335+
| RNA | m5C_2OmeC | hg38 genome | 19228[C], m[C], any[any] |
336+
| RNA | m6A_DRACH | hg38 genome | a[A], any[any] |
337+
| RNA | pseU_2OmeU | hg38 genome | 19227[T], 17802[T], any[any] |
338+
| RNA | m5C_2OmeC_inosine_m6A_2OmeA_pseU_2OmeU_2OmeG | hg38 genome | 17596[A], any[any] |
339+
| RNA | 2OmeG | gencode.v40 transcriptome | 19229[G], 19229[any] |
340+
| RNA | inosine_m6A_2OmeA | gencode.v40 transcriptome | 69426[A], a[A], 17596[A] |
341+
| RNA | m5C_2OmeC | gencode.v40 transcriptome | 19228[C], m[C], any[any] |
342+
| RNA | m6A_DRACH | gencode.v40 transcriptome | a[A], any[any] |
343+
| RNA | pseU_2OmeU | gencode.v40 transcriptome | 19227[T], 17802[T], any[any] |
344+
| RNA | m5C_2OmeC_inosine_m6A_2OmeA_pseU_2OmeU_2OmeG | gencode.v40 transcriptome | 69426[A], any[any] |
323345
324346
# Modification threshold
325347
Base modification threshold can be set for freq tool using -m option.

test/test.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ echo -e "${GREEN}${testname} passed!${NC}\n"
602602

603603

604604

605-
#************** dna_5mCG_5hmCG_mm_chr22 C|h|. C|m|. **************
605+
#************** dna_5mC_5hmC_mm_chr22 C|h|. C|m|. **************
606606
testname="view m[CG] dna_5mC_5hmC_mm_chr22.bam"
607607
echo -e "${BLUE}${testname}${NC}"
608608
ex ./minimod view --skip-supplementary -c m[CG] test/tmp/genome_chr22.fa test/data/dna_5mC_5hmC_mm_chr22.bam > test/tmp/dna_5mC_5hmC_mm_chr22.mm.view.m.CG.tsv || die "${testname} Running the tool failed"

0 commit comments

Comments
 (0)