Releases: DIncalciLab/samurai
v1.4.0 - "Ashikaga Takauji"
v1.4.0 - "Ashikaga Takauji" (2025-12-11)
This release moves from an in-house snapshot of ichorCNA to the upstream nf-core (which required some fixes in ichorCNA and the bioconda package as well). It also moves away from the fragile "PoN files are gathered from a directory" to a more robust "normals are defined in the samplesheet". Notice that this version introduces significant breaking changes from the previous ones, which will require changes in workflow parameters. Make sure to read the section "Breaking changes" carefully before upgrading.
This release is named after Ashikaga Takauji (足利尊氏; 1305-1358), the founder of the Ashikaga shogunate during the Japanese Middle Ages, whose rise to power marked the beginning of the Muromachi period (1336-1576; "Muromachi" was the area of Kyoto where the Ashikaga took residence).
Breaking changes
- A new mandatory column has been added in the samplesheet,
status, which can be eithernormalortumor(@lbeltrame, issue #13) - Option
--pon_pathhas been removed. Instead, add your normal samples to the samplesheet (same rules as case samples) with thenormalstatus - Due to a bug in ichorCNA with security implications, the syntax of all options regarding ichorCNA chromosome handling (but not the
readcounterparameters) has changed:- Specify chromosomes with identifier only (without
chr) - Valid values are individual chromosomes, separated by comma (e.g.
1or1,2), ranges using:(1:22) or a combination of the above (1:22, X). If you setichorcna_genomestyle, the right prefix will be appended for you when running the analysis ichorcna_plotylimnow takes a min and max value separated by comma (e.g.-2,4)- All the ichorCNA options that require
TRUEorFALSEnow take a booleantrueorfalse - Raw R in any ichorCNA option (e.g.
c(1,2)) is no longer supported and will raise an error.
- Specify chromosomes with identifier only (without
New features
- Support the latest version of ichorCNA (@lbeltrame and @SaraPotente, PR #57)
- Fix generating panel of normals without sufficient reads on chromosome X (GavinHaLab/ichorCNA#26; bioconda/bioconda-recipes#61045; nf-core/modules#9531)
- Update the ichorCNA modules to the latest upstream nf-core versions (@lbeltrame, PR #57)
- PoN support in the samplesheet (@lbeltrame, #13, PR #57)
Bug fixes
- Don't raise an error if in CIN quantification there is only one sample (#59, @lbeltrame)
v1.3.1 - "Mori Ranmaru"
v1.3.1 - "Mori Ranmaru" (2025-11-17)
This release is a hotfix for a regression in size selection that somehow slipped under the radar.
Mori Ranmaru (森蘭丸, 1565-1582) was a retainer of warlord Oda Nobunaga during the Sengoku period, kown for his loyalty to his master.
Bug Fixes
- Pass the right number of arguments to
samtools view(@lbeltrame, c9e8b01)
v1.3.0 - "Uesugi Kenshin"
v1.3.0 - "Uesugi Kenshin" (2025-11-25)
This release brings a few bug fixes and a large internal reorganization to make the pipeline more robust. There are also a few new features, like better alignment parameters in BWA for cfDNA, support for read groups in BAM, and initial work towards using upstream nf-core modules.
This release is named after Uesugi Kenshin (上杉謙信, 1530-1578), also known as 越後の龍 (the dragon of Echigo), a powerful warrior ruling over the province of Echigo during the Sengoku period of feudal Japan. Kenshin and Takeda Shingen were notoriously rivals, and they allegedly fought against each other in personal combat during the fourth battle of Kawanakajima (1561).
New Features
- Support read groups (#54), @lbeltrame)
- Use optimized parameters for BWA alignment when dealing with cfDNA (#36, @lbeltrame) - Thanks to @SPPearce for the insight!
- Rename
broadandfocalin GISTIC output tolongandshortrespectively to reduce the confusion with broad and focal lesions as defined by GISTIC itself (c3d17b8, @lbeltrame)
Bug Fixes
- Make pipeline parameters conditional (#23, @lbeltrame)
- Clamp ploidy aware log2ratios to -0.5 as lower bound to prevent nonsense results (e.g., -7) (6c02573, @lbeltrame)
Internal changes
- Remove usage of
paramsas much as possible (#21, @lbeltrame) - Use the upstream nf-core WisecondorX module and workflow(PR #51, @lbeltrame)
- Switch liquid biopsy to the common ichorCNA workflow (PR #55, @lbeltrame)
v1.2.3.1 - "Nitta Yoshisada" hotfix
v1.2.3.1- [2025-07-22]
This release is a hotfix to ensure that ichorCNA panel of normals (PoN) built during the analysis (as opposed to using a pre-made one) will actually be used (before that the would get copied, but not included in the ichorCNA commands). Shout out to @LMannarino for finding the issue.
Bug Fixes
- Honor the PoN used, either as CLI argument or built during analysis(830f9e5, @lbeltrame)
Full Changelog: v1.2.3...v1.2.3.1
v1.2.3 - "Nitta Yoshisada"
v1.2.3 - "Nitta Yoshisada" - [2025-07-21]
This release fixes a critical bug in the logR correction for GISTIC in ichorCNA, which caused wrong logR values to be generated. In addition, there are other fixes in ichorCNA (in particular now PoNs in data without chromosome X can be generated) and a small new feature (absolute integer CN in ASCAT.sc).
Nitta Yoshisada (新田義貞, 1301-1338) was a samurai lord during the Nanboku-cho period in Japan, also briefly involved in the wars following the so-called "Kenmu Restoration".
New Features
- Add integer absolute copy numbers to ASCAT.sc (#38, @SaraPotente)
Bug Fixes
- Fix GISTIC logR correction in ichorCNA (@lbeltrame, 0022735)
- Make sure the ichorCNA PoN generation works even in absence of data on chrX (@lbeltrame, 5e292ce)
Full Changelog: v1.2.2...v1.2.3
v1.2.2 - "Shibata Katsuie"
v1.2.2 - "Shibata Katsuie" - [2025-07-10]
This release fixes a bug in the workflow caused by the new genomic plotting feature in the ichorCNA workflow.
Shibata Katsuie (柴田勝家; 1522-1583), also known with the name of Gonroku (権六) was a retainer of the Oda clan, serving under Oda Nobuhide and Oda Nobunaga during the "Warring States" period in Japan.
Bug Fixes
- Fix undefined output variable (9418166, @SaraPotente)
Full Changelog: v1.2.1...v1.2.2
v1.2.1 - "Maeda Toshiie"
v1.2.1 - "Maeda Toshiie" - [2025-07-04]
This release fixes a bug in the new ichorCNA plotting introduced in version 1.2.0: plotting would not work due to a missing dependency in the container. A new container image has been made to correct this problem.
Maeda Toshiie (前田利家; 1538-1599), also known as "Yari no Mataza" (槍の又左) was a leading general under Oda Nobunaga during the "Warring States" period in Japan.
Bug Fixes
- Add missing
svglitedependency to the container (@lbeltrame, 3a0f076)
Full Changelog: v1.2.0...v1.2.1
v1.2.0
v1.2.0 - "Ohori Tsuruhime" - [2025-06-30]
This release adds support for ichorCNA in the solid biopsy workflow (see PR #42 for caveats) and new ploidy-aware plots for ichorCNA (off by default), which can be enabled by setting the option --ichorcna_ploidy_aware_plot.
This release is named after Ohori Tsuruhime (大祝鶴姫; 1526–1543), an "onna-musha" (female warrior) who lived and fought during the "Warring States" period in Japan. A suit of armor allegedly belonging to Tsuruhime is kept in the treasure hall of Oyamazumi Shrine, on the island of Omishima.
New features
- New plots for ichorCNA output (PR #44, @SaraPotente)
- Allow ichorCNA also in the solid biopsy workflow (PR #42, @lbeltrame)
Internal changes
- Move ichorCNA to a separate subworkflow
Full Changelog: v1.1.0...v1.2.0
v1.1.0 - "Takeda Shingen"
v1.1.0 - "Takeda Shingen" - [2025-04-29]
This release introduces support for homologous recombination deficiency (HRD) detection using HRDCNA on top of the existing bug fixes from the 1.0.x. releases.
This release is named after Takeda Shingen (1521-1573), a warlord who ruled the province of Kai during the "Warring States" (Sengoku jidai) period.
New features
- HRDCNA integration by @SaraPotente in #35
Full Changelog: v1.0.7...v1.1.0
v.1.0.7
1.0.7 - Bug fix release
This release fixes a bug with ASCAT.sc summary tables being incorrectly saved if refitting was enabled (default).
Thanks to @llanc-h for pointing out the problem.
Bug fixes
- Don't assume ASCAT.sc summary results are the same between refitted and non-refitted analyses (cb46c8a)