Skip to content

Commit 061382c

Browse files
committed
DOC: Fix README flowchart
- Use <br/> instead of \n. For some reason, the latter apparently stopped working (both in the mermaid live editor and on github) -- before \n would cause a linebreak, but now it just causes the literal text \n to show up in the flowchart (which is funny, but not what I want here...) See https://stackoverflow.com/q/51366763 for some discussion on this -- including an answer from 2022 where someone says that \n works! - The newer version of mermaid introduced a bug where nodes with long labels just straight-up don't have the label show up anymore: mermaid-js/mermaid#5785 This impacted the "strainFlye call p-mutation" and "strainFlye call r-mutation" nodes. This will probably be fixed eventually on mermaid/github's side, but for now the workaround is just manually adding linebreaks to those node names. Sidenote about that github issue link above: it includes a pointer to PLukas2018/diffkemp@6aae129, where someone else fixed the exact two problems above. this indicates that these issues are due to the mermaid version update.
1 parent 32c6485 commit 061382c

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

README.md

+22-21
Original file line numberDiff line numberDiff line change
@@ -22,50 +22,51 @@ flowchart LR
2222
classDef art fill:#acfeb1,stroke:#086408,color:black
2323
classDef pgm fill:#88bbff,stroke:#3333aa,color:black
2424
classDef ext fill:#ffbb88,stroke:#755237,color:black
25-
0(("Contigs\n(FASTA)")):::art --> A:::pgm;
26-
1(("Reads\n((gzipped) FASTA\nor FASTQ)")):::art ---> A
27-
2(("Assembly graph\n(GFA 1)")):::art -.->|"(Optional)"| A
28-
A[strainFlye align] --> 3(("Alignment of\nreads to contigs\n(Indexed BAM)")):::art
29-
3 --> C["strainFlye call p-mutation\n(Call mutations using frequencies)"]:::pgm
25+
0(("Contigs<br/>(FASTA)")):::art --> A:::pgm;
26+
1(("Reads<br/>((gzipped) FASTA<br/>or FASTQ)")):::art ---> A
27+
2(("Assembly graph<br/>(GFA 1)")):::art -.->|"(Optional)"| A
28+
A[strainFlye align] --> 3(("Alignment of<br/>reads to contigs<br/>(Indexed BAM)")):::art
29+
3 --> C["strainFlye call p-mutation<br/>(Call mutations<br/>using frequencies)"]:::pgm
3030
0 --> C
31-
3 --> D["strainFlye call r-mutation\n(Call mutations using read counts)"]:::pgm
31+
3 --> D["strainFlye call r-mutation<br/>(Call mutations<br/>using read counts)"]:::pgm
3232
0 --> D
33-
C --> 4(("Called mutations\n(Indexed BCF)")):::art
34-
C --> 5(("Diversity indices\n(TSV)")):::art
33+
C --> 4(("Called mutations<br/>(Indexed BCF)")):::art
34+
C --> 5(("Diversity indices<br/>(TSV)")):::art
3535
D --> 4
3636
D --> 5
3737
0 --> E[strainFlye fdr estimate]:::pgm
3838
3 --> E
3939
4 --> E
4040
5 -..->|"(Optional)"| E
41-
E --> 6(("FDR estimates\n(TSV)")):::art
42-
E --> 7(("# mutations / Mb\n(TSV)")):::art
43-
7 --> Z{"Plotting FDR curves\n(see tutorial)"}:::ext
41+
E --> 6(("FDR estimates<br/>(TSV)")):::art
42+
E --> 7(("Number of mutations / Mb<br/>(TSV)")):::art
43+
7 --> Z{"Plotting FDR curves<br/>(see tutorial)"}:::ext
4444
6 --> Z
4545
6 --> F[strainFlye fdr fix]:::pgm
46-
4 --> F --> 11(("Mutations with\nfixed FDR\n(Indexed BCF)")):::art
46+
4 --> F --> 11(("Mutations with<br/>fixed FDR<br/>(Indexed BCF)")):::art
4747
11 --> G[strainFlye spot hot-features]:::pgm
48-
8(("Contig #quot;features#quot;\n[probably genes]\n(GFF3)")):::art --> G
49-
G --> 9(("Hotspot features\n(TSV)")):::art
50-
11 --> H[strainFlye spot cold-gaps]:::pgm --> 10(("Coldspot gaps\n(TSV)")):::art
48+
8(("Contig #quot;features#quot;<br/>[probably genes]<br/>(GFF3)")):::art --> G
49+
G --> 9(("Hotspot features<br/>(TSV)")):::art
50+
11 --> H[strainFlye spot cold-gaps]:::pgm --> 10(("Coldspot gaps<br/>(TSV)")):::art
5151
4 -.->|If desired, you can skip FDR estimation and fixing and use the unfiltered BCF file for downstream analyses| 11
52-
11 --> I[strainFlye smooth create]:::pgm --> 12(("Smoothed and\nvirtual reads\n(gzipped FASTA)")):::art
52+
11 --> I[strainFlye smooth create]:::pgm --> 12(("Smoothed and<br/>virtual reads<br/>(gzipped FASTA)")):::art
5353
0 --> I
5454
3 --> I
5555
5 -.->|"(Optional)"| I
5656
12 --> J[strainFlye smooth assemble]:::pgm --> 13(("LJA assemblies")):::art
5757
11 --> K
58-
0 --> K[strainFlye link nt]:::pgm --> 14(("Nucleotide\n(co-)occurrence\ninformation\n(Pickle)")):::art
58+
0 --> K[strainFlye link nt]:::pgm --> 14(("Nucleotide<br/>(co-)occurrence<br/>information<br/>(Pickle)")):::art
5959
3 --> K
60-
14 --> L[strainFlye link graph]:::pgm --> 15(("Link graphs\n(DOT or Pickle)")):::art
60+
14 --> L[strainFlye link graph]:::pgm --> 15(("Link graphs<br/>(DOT or Pickle)")):::art
6161
0 --> M[strainFlye matrix count]:::pgm
6262
3 --> M
6363
8 ---> M
64-
M --> 16(("3-mer count\ninformation\n(Pickle)")):::art
65-
16 --> N[strainFlye matrix fill]:::pgm --> 17(("Mutation matrices\n(TSV or JSON)")):::art
66-
0 --> O[strainFlye dynam covskew]:::pgm --> 18(("Coverage and\nskew statistics\n(TSV)")):::art
64+
M --> 16(("3-mer count<br/>information<br/>(Pickle)")):::art
65+
16 --> N[strainFlye matrix fill]:::pgm --> 17(("Mutation matrices<br/>(TSV or JSON)")):::art
66+
0 --> O[strainFlye dynam covskew]:::pgm --> 18(("Coverage and<br/>skew statistics<br/>(TSV)")):::art
6767
3 --> O
6868
2 --> P[strainFlye utils gfa-to-fasta]:::pgm --> 0
69+
6970
```
7071

7172
## Installation

0 commit comments

Comments
 (0)