Skip to content

Commit 442e6ba

Browse files
lubitelpospatArtRand
authored andcommitted
DMR documentation enhancement
1 parent 48810f1 commit 442e6ba

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

book/src/intro_dmr.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ The output from `modkit dmr pair` (and for each pairwise comparison with `modkit
174174
| 5 | score | difference score, more positive values have increased difference | float |
175175
| 6 | strand | strand for the region or single-base position | str |
176176
| 7 | sample<sub>a</sub> counts | counts of each base modification in the region, comma-separated, for sample A | str |
177-
| 8 | sample<sub>a</sub> total | total number of base modification calls in the region, including unmodified, for sample A | str |
177+
| 8 | sample<sub>a</sub> total | total number of base modification calls in the region, including unmodified, for sample A | int |
178178
| 9 | sample<sub>b</sub> counts | counts of each base modification in the region, comma-separated, for sample B | str |
179-
| 10 | sample<sub>b</sub> total | total number of base modification calls in the region, including unmodified, for sample B | str |
179+
| 10 | sample<sub>b</sub> total | total number of base modification calls in the region, including unmodified, for sample B | int |
180180
| 11 | sample<sub>a</sub> percents | percent of calls for each base modification in the region, comma-separated, for sample A | str |
181181
| 12 | sample<sub>b</sub> percents | percent of calls for each base modification in the region, comma-separated, for sample B | str |
182182
| 13 | sample<sub>a</sub> fraction modified | fraction modification (of any kind) in sample A | float |
@@ -247,6 +247,28 @@ modkit dmr pair \
247247
```
248248
these columns will not be present.
249249

250+
The full table when performing single-site analysis with equal numbers of samples in groups, when running `modkit dmr pair`, will have the following schema:
251+
252+
| column | name | description | type |
253+
|--------|--------------------------------------|------------------------------------------------------------------------------------------------------------|-------|
254+
| 1 | chrom | name of reference sequence from bedMethyl input samples | str |
255+
| 2 | start position | 0-based start position, from `--regions` argument | int |
256+
| 3 | end position | 0-based exclusive end position, from `--regions` argument | int |
257+
| 4 | name | `name` column from `--regions` BED, or `chr:start-stop` if absent, "." for single sites | str |
258+
| 5 | score | difference score, more positive values have increased difference | float |
259+
| 6 | strand | strand for the region or single-base position | str |
260+
| 7 | sample<sub>a</sub> counts | counts of each base modification in the region, comma-separated, for sample A | str |
261+
| 8 | sample<sub>a</sub> total | total number of base modification calls in the region, including unmodified, for sample A | int |
262+
| 9 | sample<sub>b</sub> counts | counts of each base modification in the region, comma-separated, for sample B | str |
263+
| 10 | sample<sub>b</sub> total | total number of base modification calls in the region, including unmodified, for sample B | int |
264+
| 11 | sample<sub>a</sub> percents | percent of calls for each base modification in the region, comma-separated, for sample A | str |
265+
| 12 | sample<sub>b</sub> percents | percent of calls for each base modification in the region, comma-separated, for sample B | str |
266+
| 13 | sample<sub>a</sub> fraction modified | fraction modification (of any kind) in sample A | float |
267+
| 14 | sample<sub>b</sub> fraction modified | fraction modification (of any kind) in sample B | float |
268+
| 15 | MAP-based p-value | ratio of the posterior probability of observing the effect size over zero effect size | float |
269+
| 16 | effect size | percent modified in sample A (col 12) minus percent modified in sample B (col 13) | float |
270+
| 17 | balanced MAP-based p-value | MAP-based p-value when all replicates are balanced | float |
271+
| 18 | balanced effect size | effect size when all replicates are balanced | float |
250272

251273
## Segmenting on differential methylation
252274

0 commit comments

Comments
 (0)