Skip to content

Commit 3fea88a

Browse files
committed
Update README.md
1 parent 96e686b commit 3fea88a

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ This repo contains the data in relation to the maxATAC project. For complete ins
88

99
This directory contains:
1010

11-
1. `hg38_maxatac_blacklist.bed`: maxATAC extended blacklist
12-
2. `hg38_maxatac_blacklist.bw`:
13-
3. `hg38.chrom.sizes`: chromosome sizes
11+
1. `hg38_maxatac_blacklist.bed`: bed file of maxATAC blacklist regions
12+
2. `hg38_maxatac_blacklist.bw`: bed file of maxATAC blacklist regions
13+
3. `hg38.chrom.sizes`: hg38 chromosome sizes file
1414

1515
## `./models`
1616

17-
Information on 127 TF models trained. Each directory is a TF name. Each directory contains a `.h5` of the best TF model, a `.tsv` file of threshold statistics, and a `.png` of the statistcs.
17+
Information for the 127 TF models available through maxATAC. Each directory is a TF name. Each directory contains a `.h5` of the best TF model, a `.tsv` file of threshold statistics, and a `.png` of the statistics.
1818

1919
Example directory structure:
2020

@@ -25,6 +25,24 @@ Example directory structure:
2525
| |____ATF2_validationPerformance_vs_thresholdCalibration.tsv
2626
```
2727

28+
### Example threshold statistics file
29+
30+
This is an example of the first 6 lines of the threshold statistics file used to call peaks. The first column is the threshold. Every column after is the average performance reported for different metrics on validation chromosome 2.
31+
32+
```pre
33+
Standard_Thresh Monotonic_Avg_Precision Monotonic_Avg_Recall Monotonic_Avg_log2FC Avg_F1
34+
0.0 0.0035793736711456103 0.9910269020975186 0.4617435633366975 0.0071224011910284366
35+
0.001 0.018103716393149 0.9242690259191988 2.996816276717381 0.03517534734171995
36+
0.002 0.027523721672056148 0.92192080328679 3.5979115724538913 0.05275399945034204
37+
0.003 0.03384312047545328 0.9123870842533509 3.8788363137406194 0.06429293366464785
38+
0.004 0.03872007478681639 0.9030209327592842 4.055800482157333 0.07305708818396862
39+
0.005 0.04270041191717275 0.9017292649083462 4.199724330597559 0.0801251221410759
40+
```
41+
42+
### Example threshold statistics image
43+
44+
![ARID3A Threshold Statistics](models/ELK1/ELK1_validationPerformance_vs_thresholdCalibration.png)
45+
2846
## `./scripts`
2947

3048
A directory of scripts that are used to process the ATAC-seq, DHS, and ChIP-seq data analyzed by our publication. The scripts `ATAC_bowtie2_pipeline.sh` and `scatac_generate_bigwig.sh` are required for running `maxatac prepare`.

0 commit comments

Comments
 (0)