From 99481e416d7d090f3cbb74f30e2ae9282ce3cd57 Mon Sep 17 00:00:00 2001 From: "Akshata N. Rudrapatna" <139808049+ANRudrapatna@users.noreply.github.com> Date: Tue, 14 Jul 2026 14:08:30 -0400 Subject: [PATCH 1/4] Update prepare.md --- docs/readme/prepare.md | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/docs/readme/prepare.md b/docs/readme/prepare.md index a43d0ef..9306e16 100644 --- a/docs/readme/prepare.md +++ b/docs/readme/prepare.md @@ -54,38 +54,42 @@ This argument is used to set the prefix for setting the filenames. The default values for the optional arguments are based on the testing performed in the maxATAC publication. See the [Methods](https://www.biorxiv.org/content/10.1101/2022.01.28.478235v1.article-metrics) of our publication for a detailed explanation of each parameter choice. -### `-skip_dedup`, `--skip_deduplication` +### `--blacklist` -It is important to remove PCR duplicates from your ATAC-seq data if you have not done so already. Include this flag to perform PCR deduplication of the input BAM file if you know that it has not been deduplicated. Skipping this step will speed up data processing. Defualt: False +The path to the blacklist BED file. Default: maxATAC-defined blacklisted regions for hg38. -### `-slop`, `--slop` +### `--blacklist_bw` -The slop size used to smooth sparse Tn5 cut sites' signal. Each Tn5 cut site will be extended +/- the slop size (in bp). Because maxATAC models were trained using slop size of 20bp (a value that approximates the size of Tn5 transposase), **this parameter should not be changed from default (20 bp) when using the trained models provided by maxATAC**. Default: 20 bp. +The path to the blacklist bigWig file. Default: maxATAC-defined blacklist for hg38 as a bigWig file. -### `-rpm`, `--rpm_factor` +### `-c`, `-chroms`, `--chromosomes` -The reads per million (RPM) factor used for read-depth normalization of signal. Most groups use RPM and therefore 1,000,000 as a scaling factor, but maxATAC uses RP20M and therefore 20,000,000 because it is approximately the median sequencing depth of the ATAC-seq data used for training. Changing from the default (20000000) is not problematic for maxATAC prediction, as this track is only used for visualization. (Predictions are made on a min-max-like normalized signal track, also an output from `maxatac prepare`.) Default: 20000000. +The chromosomes to use for the final output. Default: Human autosomal chromosomes chr1-22. Note: this argument MUST be specified in conjunction with `--genome` if the input BAM file was aligned to a genome build other than hg38. -### `--blacklist` +### `-cs`, `--chrom_sizes`, `--chromosome_sizes` -The path to the blacklist bed file. Default: maxATAC defined blacklisted regions for hg38. +The chromosome sizes file. Default: hg38 chrom sizes. -### `--blacklist_bw` +### --genome -The path to the blacklist bigwig file. Default: maxATAC defined blacklist for hg38 as a bigwig file. +The genome build that was used for alignment of the input BAM file. Default: hg38. -### `-cs`, `--chrom_sizes`, `--chromosome_sizes` +### `--loglevel` -The chromosome sizes file. Default: hg38 chrom sizes. +The log level to use for printing messages. -### `-c`, `-chroms`, `--chromosomes` +### `-rpm`, `--rpm_factor` -The chromosomes to use for the final output. Default: Autosomal chromosomes chr1-22. +The reads per million (RPM) factor used for read-depth normalization of signal. Most groups use RPM and therefore 1,000,000 as a scaling factor, but maxATAC uses RP20M and therefore 20,000,000 because it is approximately the median sequencing depth of the ATAC-seq data used for training. Changing from the default (20000000) is not problematic for maxATAC prediction, as this track is only used for visualization. (Predictions are made on a min-max-like normalized signal track, also an output from `maxatac prepare`.) Default: 20000000. -### `-t`, `-threads` +### `-skip_dedup`, `--skip_deduplication` -The number of threads to use. Default: Get available CPU count. +It is important to remove PCR duplicates from your ATAC-seq data if you have not done so already. Include this flag to perform PCR deduplication of the input BAM file if you know that it has not been deduplicated. Skipping this step will speed up data processing. Defualt: False -### `--loglevel` +### `-slop`, `--slop` -The log level to use for printing messages. +The slop size used to smooth sparse Tn5 cut sites' signal. Each Tn5 cut site will be extended +/- the slop size (in bp). Because maxATAC models were trained using slop size of 20bp (a value that approximates the size of Tn5 transposase), **this parameter should not be changed from default (20 bp) when using the trained models provided by maxATAC**. Default: 20 bp. + +### `-t`, `-threads` + +The number of threads to use. Default: Get available CPU count. From a6e7503f6365fe0dec49acead804714d33405397 Mon Sep 17 00:00:00 2001 From: "Akshata N. Rudrapatna" <139808049+ANRudrapatna@users.noreply.github.com> Date: Tue, 14 Jul 2026 14:15:22 -0400 Subject: [PATCH 2/4] Update prepare.md --- docs/readme/prepare.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/readme/prepare.md b/docs/readme/prepare.md index 9306e16..8ff2170 100644 --- a/docs/readme/prepare.md +++ b/docs/readme/prepare.md @@ -64,11 +64,11 @@ The path to the blacklist bigWig file. Default: maxATAC-defined blacklist for hg ### `-c`, `-chroms`, `--chromosomes` -The chromosomes to use for the final output. Default: Human autosomal chromosomes chr1-22. Note: this argument MUST be specified in conjunction with `--genome` if the input BAM file was aligned to a genome build other than hg38. +The chromosomes to use for the final output. Default: Human autosomal chromosomes chr1-22. Note: this argument MUST be specified in conjunction with `--genome` and `--chrom_sizes` if the input BAM file was aligned to a genome build other than hg38. ### `-cs`, `--chrom_sizes`, `--chromosome_sizes` -The chromosome sizes file. Default: hg38 chrom sizes. +The chromosome sizes file. Default: hg38 chrom sizes. Note: this argument MUST be specified in conjunction with `--genome` and `--chromosomes` if the input BAM file was aligned to a genome build other than hg38. ### --genome From 40a97e8ce2858e8567d219ba9f5d409b7344287c Mon Sep 17 00:00:00 2001 From: "Akshata N. Rudrapatna" <139808049+ANRudrapatna@users.noreply.github.com> Date: Tue, 14 Jul 2026 14:22:43 -0400 Subject: [PATCH 3/4] Update prepare.md --- docs/readme/prepare.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readme/prepare.md b/docs/readme/prepare.md index 8ff2170..7ca8d3b 100644 --- a/docs/readme/prepare.md +++ b/docs/readme/prepare.md @@ -72,7 +72,7 @@ The chromosome sizes file. Default: hg38 chrom sizes. Note: this argument MUST b ### --genome -The genome build that was used for alignment of the input BAM file. Default: hg38. +The genome build that was used for alignment of the input file. Default: hg38. ### `--loglevel` From 1bc03097824441641c258cc0f3c7ca9ac77d1626 Mon Sep 17 00:00:00 2001 From: "Akshata N. Rudrapatna" <139808049+ANRudrapatna@users.noreply.github.com> Date: Tue, 14 Jul 2026 14:46:22 -0400 Subject: [PATCH 4/4] Update prepare.md --- docs/readme/prepare.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/readme/prepare.md b/docs/readme/prepare.md index 7ca8d3b..690313b 100644 --- a/docs/readme/prepare.md +++ b/docs/readme/prepare.md @@ -64,11 +64,11 @@ The path to the blacklist bigWig file. Default: maxATAC-defined blacklist for hg ### `-c`, `-chroms`, `--chromosomes` -The chromosomes to use for the final output. Default: Human autosomal chromosomes chr1-22. Note: this argument MUST be specified in conjunction with `--genome` and `--chrom_sizes` if the input BAM file was aligned to a genome build other than hg38. +The chromosomes to use for the final output. Default: Human autosomal chromosomes chr1-22. Note: this argument MUST be specified in conjunction with `--genome` and `--chrom_sizes` if the input file was aligned to a genome build other than hg38. ### `-cs`, `--chrom_sizes`, `--chromosome_sizes` -The chromosome sizes file. Default: hg38 chrom sizes. Note: this argument MUST be specified in conjunction with `--genome` and `--chromosomes` if the input BAM file was aligned to a genome build other than hg38. +The chromosome sizes file. Default: hg38 chrom sizes. Note: this argument MUST be specified in conjunction with `--genome` and `--chromosomes` if the input file was aligned to a genome build other than hg38. ### --genome