Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CHANGELOG.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the changes I realized the next pipeline version will probably have to be 5.0.0 if we want to stick to semantic versioning 🥲

From https://nf-co.re/docs/specifications/pipelines/requirements/semantic_versioning:

Major Release (e.g., 1.4.3 to 2.0.0)

Changes that are not backwards compatible and may require users to adjust their existing workflows or configurations.

Breaking Changes:

  • ...
  • Renaming or deprecation of existing parameter(s).
  • ...
  • Upgrades to dependencies that introduce breaking changes. For example if the new version of the tool requires additional parameters, removes parameters passed by the pipeline, or changes its outputs in a way that necessitates changes to module output definitions.

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [[4.2.0dev](https://github.com/nf-core/pixelator/releases/tag/4.1.2dev)] - 2026-MM-DD

### Changed

- Rename `pna_sample_calling_confidence_threshold` to `pna_sample_calling_enrichment_threshold` to match pixelator 0.29.0
- Change default layout algorithm from `wpmds_3d` to `coarsened_pmds_3d`

### Enhancements & fixes

- Update pixelator container to 0.29.0
- Update pixelatorES to 0.11.2

### Software dependencies

| Dependency | Old version | New version |
| ------------- | ----------- | ----------- |
| `pixelator` | 0.28.0 | 0.29.0 |
| `pixelatorES` | 0.10.4 | 0.11.2 |

### Parameters

| Old parameter | New parameter |
| ----------------------------------------- | ----------------------------------------- |
| `pna_sample_calling_confidence_threshold` | `pna_sample_calling_enrichment_threshold` |

## [[4.1.2](https://github.com/nf-core/pixelator/releases/tag/4.1.2)] - 2026-06-04

### Enhancements & fixes
Expand Down
2 changes: 1 addition & 1 deletion conf/modules.pna.config
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ process {
[
params.pna_sample_calling_remove_incompatible ? "--remove-incompatible" : '',
params.pna_sample_calling_save_undetermined ? "--save-undetermined" : '',
params.pna_sample_calling_confidence_threshold != null ? "--confidence-threshold ${params.pna_sample_calling_confidence_threshold}" : '',
params.pna_sample_calling_enrichment_threshold != null ? "--enrichment-threshold ${params.pna_sample_calling_enrichment_threshold}" : '',
].join(' ').trim()
}
publishDir = [
Expand Down
6 changes: 5 additions & 1 deletion conf/test_proxiome_v1.config
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ params {

// Input data
input = params.pipelines_testdata_base_path + '/samplesheet/pna/samplesheet_proxiome_v1.csv'
input_basedir = params.pipelines_testdata_base_path + '/testdata/pna'
input_basedir = params.pipelines_testdata_base_path + '/new-test-data/pna'

pna_graph_component_size_min_threshold = 100

// Synthetic nf-core test datasets include components too small for
// coarsened_pmds_3d. Keep wpmds_3d in test profiles.
pna_layout_layout_algorithm = "wpmds_3d"

skip_layout = false
technology = "proxiome-v1"
save_all = true
Expand Down
8 changes: 6 additions & 2 deletions conf/test_proxiome_v2.config
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@ params {
config_profile_description = 'Minimal test dataset to check pipeline function'

// Input data
input = params.pipelines_testdata_base_path + '/samplesheet/pna/samplesheet_proxiome_v2.csv'
input_basedir = params.pipelines_testdata_base_path + '/testdata/pna'
input = params.pipelines_testdata_base_path + '/new-test-data/samplesheet/pna/samplesheet_proxiome_v2.csv'
input_basedir = params.pipelines_testdata_base_path + '/new-test-data/pna'

pna_graph_component_size_min_threshold = 100

// Synthetic nf-core test datasets include components too small for
// coarsened_pmds_3d. Keep wpmds_3d in test profiles.
pna_layout_layout_algorithm = "wpmds_3d"

skip_layout = false
technology = "proxiome-v2"
save_all = true
Expand Down
7 changes: 4 additions & 3 deletions docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,10 @@ This step uses the `pixelator single-cell-pna sample-calling` command. It takes
the graph PXL file and the sample sheet as input and assigns each component to
the most likely sample in pooled experiments.

Components with assignment confidence below the selected threshold are marked
as undetermined and can be saved to a separate output file. The resulting
per-sample dehashed PXL files are then used as input for the analysis step.
Components with sample enrichment below `pna_sample_calling_enrichment_threshold`
(default 10.0) are marked as undetermined and can be saved to a separate output
file. The resulting per-sample dehashed PXL files are then used as input for
the analysis step.

<details markdown="1">
<summary>Output files</summary>
Expand Down
4 changes: 2 additions & 2 deletions modules/local/experiment_summary/main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ process EXPERIMENT_SUMMARY {
label "error_retry"

container "${params.experiment_summary_container?: workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container
? 'quay.io/pixelgen-technologies/pixelatores:0.10.4'
: 'quay.io/pixelgen-technologies/pixelatores:0.10.4'}"
? 'quay.io/pixelgen-technologies/pixelatores:0.11.2'
: 'quay.io/pixelgen-technologies/pixelatores:0.11.2'}"

input:
path samplesheet_path
Expand Down
Loading
Loading