Skip to content

Commit 26aa346

Browse files
committed
minor edits to merge-heatmap docs
Minor edits to Merge Heatmap tool documentation including note on ways to co-opt the tool and fixing broken internal docs links. Heatmap Labeler was also fixed for broken internal docs links and header level of "Command Line Interface".
1 parent 2ead5f4 commit 26aa346

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

docusaurus/docs/figure-generation/heatmap-labeler.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ Any file with a `.png` extension may be loaded into the Label Heatmap tool. When
1919
Clicking "Generate" will execute the script to write `.svg` files, each with one of the `.png` files embedded and annotated by the user-specifications. The output files will be named like the input files with the `_label.svg` suffix replacing the `.png` extension.
2020

2121

22-
### Command Line Interface
22+
## Command Line Interface
2323

24-
[cdt-format]:file-format.md
25-
[png-format]:file-format.md
24+
[png-format]:file-formats

docusaurus/docs/figure-generation/merge-heatmap.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The following files will be paired off for merging:<br />
4646
unpaired: `SampleC_sense_treeview.png`
4747

4848
:::caution
49-
Make sure you are merging PNG files with the same pixel-dimensions.
49+
Make sure you are merging PNG files with the same pixel-dimensions. ScriptManager will terminate the process if it encounters a pair of images with unequal dimensions and report it to the user in a pop-up window.
5050
:::
5151

5252
### Details of color-averaging strategy
@@ -63,12 +63,17 @@ $A_i = (\textcolor{red}{r_a},\textcolor{green}{g_a},\textcolor{blue}{b_a})$.
6363

6464
We define the __merged `.png` heatmap__ ($P_{merge}$) pixel matrix as follows:
6565
$$
66-
\forall M_i \in P_{merge},\newline
66+
\forall M_i \in P_{merge},\\
6767
M_i = (\frac{\textcolor{red}{r_s} + \textcolor{red}{r_a}}{2},
6868
\frac{\textcolor{green}{g_s} + \textcolor{green}{g_a}}{2},
6969
\frac{\textcolor{blue}{b_s} + \textcolor{blue}{b_a}}{2})
7070
$$
7171

72+
:::note
73+
See from the above specifications $P_{sense}$ and $P_{anti}$ could be swapped around with no effect on the merged output. In other words, the tool is not doing anything fancy or ChIP-exo specific and is agnostic to the specifics of the input outside of the dimensions and the `.png` format. Should the need arise, you could co-opt the command line interface for merge heatmap to bypass the file naming enforcement strategy employed by the graphical interface to merge any pair of `.png` files with the same dimensions.
74+
:::
75+
76+
7277
## Command Line Interface
7378
Usage:
7479
```bash
@@ -93,8 +98,8 @@ Expects two [PNG][png-format] like the output from the [heatmap tool][heatmap].
9398

9499

95100

96-
[cdt-format]:file-format.md
97-
[png-format]:file-format.md
101+
[cdt-format]:file-formats
102+
[png-format]:file-formats
98103

99104
[heatmap]:figure-generation/heatmap.md
100105
[chip-exo-tutorial]:threebasicplots-exo.md

0 commit comments

Comments
 (0)