22bIOINFORMATICS @WUST
33
44# Installation
5- git clone https://github.com/Karo555/needleman-wunsch.git <br >
6- cd needleman-wunsch-aligner <br >
7- pip install -e .[ html,pdf]
5+ ` git clone https://github.com/Karo555/needleman-wunsch.git ` <br >
6+ ` cd needleman-wunsch-aligner ` <br >
7+ ` pip install -e .[html,pdf] `
88
99# Usage
10101 . Basic DNA alignment (manual input) <br >
11- needleman-wunsch --manual
11+ ` needleman-wunsch --manual `
1212
1313You’ll be prompted to enter:
1414- Sequence 1 ID
@@ -17,26 +17,26 @@ You’ll be prompted to enter:
1717- Sequence 2
1818
19192 . FASTA file input <br >
20- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --output reports/alignment.txt <br >
20+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --output reports/alignment.txt ` <br >
2121
2222data/seq1.fasta and data/seq2.fasta each contain exactly one record. <br >
2323The text report is saved to reports/alignment.txt <br >
2424
25253 . Custom scoring. Override match, mismatch, and gap scores. <br >
26- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --match 2 --mismatch -1 --gap -2
26+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --match 2 --mismatch -1 --gap -2 `
2727
28284 . Enumerate all optimal alignments <br >
29- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --all-paths --output reports/all_paths.txt
29+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --all-paths --output reports/all_paths.txt `
3030
3131Lists every equally optimal alignment and writes them to reports/all_paths.txt.
3232
33335 . Export raw DP matrix as CSV <br >
34- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --matrix-out reports/matrix.csv
34+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --matrix-out reports/matrix.csv `
3535
3636The full (N+1)×(M+1) score matrix is saved in comma‐separated format for downstream analysis
3737
38386 . Structured JSON output <br >
39- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --json reports/alignment.json
39+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --json reports/alignment.json `
4040
4141Produces a JSON file containing: <br >
4242
@@ -46,12 +46,12 @@ Full DP matrix
4646All alignments with per-path statistics
4747
48487 . Heatmap visualization <br >
49- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png
49+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png `
5050
5151Renders the DP matrix as a heatmap PNG saved to plots/heatmap.png.
5252
53538 . HTML summary report <br >
54- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png --html reports/alignment.html
54+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png --html reports/alignment.html `
5555
5656Generates a standalone HTML page embedding:
5757
@@ -61,15 +61,15 @@ Inline statistics
6161The heatmap image (correctly linked)
6262
6363Open it in your browser via:
64- python3 -m http.server 8000
64+ ` python -m http.server 8000`
6565
66- then visit http://localhost:8000/reports/alignment.html
66+ then visit ` http://localhost:8000/reports/alignment.html `
6767
68689 . PDF summary report <br >
69- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png --pdf reports/alignment.pdf
69+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png --pdf reports/alignment.pdf `
7070
717110 . one shot <br >
72- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --all-paths --match 2 --mismatch -1 --gap -2 --output reports/alignment.txt --matrix-out reports/matrix.csv --json reports/alignment.json --plot plots/heatmap.png --html reports/alignment.html --pdf reports/alignment.pdf
72+ ` needleman-wunsch --input data/seq1.fasta data/seq2.fasta --all-paths --match 2 --mismatch -1 --gap -2 --output reports/alignment.txt --matrix-out reports/matrix.csv --json reports/alignment.json --plot plots/heatmap.png --html reports/alignment.html --pdf reports/alignment.pdf `
7373
7474reports/alignment.txt (text report)<br >
7575reports/matrix.csv (raw DP matrix)<br >
0 commit comments