gensplore 0.0.16 → 0.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -70,6 +70,16 @@ file picker and URL input. Alignment runs in a browser worker; results show
70
70
  reference-relative DNA differences and translated changes above affected AA
71
71
  ribbons. Synonymous changes have no AA label; frameshifts and unsupported
72
72
  translation annotations are handled explicitly. Biological function is not predicted. See the root
73
- README for alignment limits and coordinate conventions.
73
+ README for alignment details and coordinate conventions.
74
+
75
+ Alignment is powered by **[Nextclade](https://github.com/nextstrain/nextclade)** (MIT license,
76
+ by the Nextstrain team): its nucleotide and amino-acid aligners run as WebAssembly
77
+ inside the component's worker. Please cite Nextclade if you use these comparisons
78
+ (Aksamentov et al. 2021, *JOSS* 6(67), 3773, <https://doi.org/10.21105/joss.03773>).
79
+
80
+ Alignment uses Nextclade's defaults. To reproduce a Nextclade dataset's calls, pass
81
+ its pathogen.json `alignmentParams` as `alignmentParams`, for example
82
+ `{ gapAlignmentSide: "right", excessBandwidth: 12, terminalBandwidth: 100, allowedMismatches: 4, minSeedCover: 0.1 }`
83
+ for SARS-CoV-2.
74
84
 
75
85
  For an existing reference-coordinate alignment, pass `alignedSequence={{ name, sequence, insertions }}` instead of `fastaUrl`. The sequence has one IUPAC base (including `N`) or deletion gap (`-`) per reference base. Insertions are `{ position, sequence }`, where position is the number of reference bases before the insertion (0 means before the first base). This preserves supplied gap placement and bypasses FASTA realignment. Removing the prop clears the comparison.