Skip to content

Commit 480ef95

Browse files
committed
docs: changelog
1 parent 02dd0a1 commit 480ef95

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

Diff for: CHANGELOG.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,30 @@
1-
# PanGraph Changelog
1+
## Unreleased
2+
3+
This release introduces several significant updates, including a complete rewrite of the algorithm in Rust to boost both speed and reliability in graph construction. PanGraph can now be compiled as a standalone binary, greatly simplifying installation. The release also contains several **breaking changes**.
4+
5+
### Major changes
6+
7+
- **Graph Construction Algorithm Enhancements**
8+
- Block merging has been refined and simplified: when merging two blocks, sequences are re-aligned to the block consensus, resulting in more robust alignments.
9+
- The alignment process is now easily parallelizable, extending beyond the previous limitation of parallel guide tree traversal.
10+
- Insertions are now placed on the consensus sequence without aligning them to each other, simplifying bookkeeping of alignment variation when merging blocks.
11+
12+
- **Graph JSON Output Format Updates**
13+
- A new `nodes` dictionary links paths and blocks.
14+
- Entries in the `paths` dictionary have been simplified to include only lists of nodes.
15+
- Block `alignments` now use a simpler encoding; insertions are placed on the consensus without alignment, eliminating the need for a separate `gaps` entry.
16+
17+
- **Command Line Interface Modifications**
18+
- Improved parallelization control with the new `--jobs` flag.
19+
- The `export` command has been restructured into several subcommands:
20+
- `export gfa` – Export the graph in GFA format.
21+
- `export block-consensus` – Export block consensus sequences in a single FASTA file.
22+
- `export block-sequences` – Export each block’s alignment in separate FASTA files.
23+
- `export core-genome` – Export the core-genome alignment.
24+
- The `marginalize` command has been renamed to `simplify`.
25+
- A new `reconstruct` command has been added to rebuild the input sequences from the graph.
26+
- The `polish` and `generate` commands have been removed.
27+
228

329
## v0.6.0
430

0 commit comments

Comments
 (0)