Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.4 #121

Open
wants to merge 49 commits into
base: master
Choose a base branch
from
Open

Release 1.4 #121

wants to merge 49 commits into from

Conversation

fbdtemme
Copy link
Collaborator

Release 1.4

[1.4.0] - 2024-12-13

Enhancements & fixes

  • [PR #111] - Template update for nf-core/tools v3.0.2
  • [PR #112] - Add graph refinement options for pixelator 0.19
  • [PR #113] - Fix validation issues after nf-core/tools v3.0.2 update
  • [PR #114] - Remove --save_recovered_components options for graph outputs
  • [PR #115] - Update containers for pixelator 0.19
  • [PR #116] - Bump version to 1.4
  • [PR #117] - Template update for nf-core/tools v3.1.0
  • [PR #118] - Update metromap, bump conda versions
  • [PR #120] - Add process_long to AMPLICON and COLLAPSE steps

nf-core-bot and others added 30 commits October 8, 2024 12:31
Important! Template update for nf-core/tools v3.0.2
Add graph refinement options for pixelator 0.19
Fix validation issues after nf-core/tools v3 template update
…overed

Remove `--save_recovered_components` options for graph outputs
Copy link

github-actions bot commented Dec 13, 2024

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit ca529a0

+| ✅ 229 tests passed       |+
#| ❔   5 tests were ignored |#
!| ❗   6 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in ro-crate-metadata.json: "description": "

    \n \n <source media="(prefers-color-scheme: dark)" srcset="docs/images/nf-core-pixelator_logo_dark.png">\n <img alt="nf-core/pixelator" src="docs/images/nf-core-pixelator_logo_light.png">\n \n

    \n\nGitHub Actions CI Status\nGitHub Actions Linting StatusAWS CICite with Zenodo\nnf-test\n\nNextflow\nrun with conda\nrun with docker\nrun with singularity\nLaunch on Seqera Platform\n\nGet help on SlackFollow on TwitterFollow on MastodonWatch on YouTube\n\n## Introduction\n\nnf-core/pixelator is a bioinformatics pipeline that ...\n\n TODO nf-core:\n Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the\n major pipeline sections and the types of output it produces. You're giving an overview to someone new\n to nf-core here, in 15-20 seconds. For an example, see https://github.com/nf-core/rnaseq/blob/master/README.md#introduction\n\n\n Include a figure that guides the user through the major workflow steps. Many nf-core\n workflows use the "tube map" design for that. See https://nf-co.re/docs/contributing/design_guidelines#examples for examples. \n Fill in short bullet-pointed list of the default steps in the pipeline \n\n\n\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.\n\n Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.\n Explain what rows and columns represent. For instance (please edit as appropriate):\n\nFirst, prepare a samplesheet with your input data that looks as follows:\n\nsamplesheet.csv:\n\ncsv\nsample,fastq_1,fastq_2\nCONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz\n\n\nEach row represents a fastq file (single-end) or a pair of fastq files (paired end).\n\n\n\nNow, you can run the pipeline using:\n\n update the following command to include all required parameters for a minimal example \n\nbash\nnextflow run nf-core/pixelator \\\n -profile <docker/singularity/.../institute> \\\n --input samplesheet.csv \\\n --outdir <OUTDIR>\n\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.\n\nFor more details and further functionality, please refer to the usage documentation and the parameter documentation.\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\noutput documentation.\n\n## Credits\n\nnf-core/pixelator was originally written by Pixelgen Technologies AB.\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n If applicable, make list of people who have also contributed \n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the contributing guidelines.\n\nFor further information or help, don't hesitate to get in touch on the Slack #pixelator channel (you can join with this invite).\n\n## Citations\n\n Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. \n If you use nf-core/pixelator for your analysis, please cite it using the following doi: 10.5281/zenodo.XXXXXX \n\n Add bibliography of tools and data used in your pipeline \n\nAn extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.\n\nYou can cite the nf-core publication as follows:\n\n> The nf-core framework for community-curated bioinformatics pipelines.\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.\n",
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.1.0
  • Run at 2025-01-03 10:57:48

@ambarrio
Copy link
Collaborator

Can you give us a hand on this one @mashehu and @avani-bhojwani on a short timeline? Thanks!

@avani-bhojwani
Copy link
Contributor

consider updating to version 2.0.0, rather than 1.4.0 since the deprecation of a parameter could justify a major release (https://nf-co.re/docs/guidelines/pipelines/requirements/semantic_versioning#major-release-eg-143-to-200)

Copy link
Contributor

@avani-bhojwani avani-bhojwani left a comment

Choose a reason for hiding this comment

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

Looks good - Just a few questions/changes

nextflow.config Show resolved Hide resolved
conf/base.config Outdated Show resolved Hide resolved
conf/pixelgen_aws.config Outdated Show resolved Hide resolved
@fbdtemme
Copy link
Collaborator Author

fbdtemme commented Jan 3, 2025

Since the push to follow semantic versioning more strictly is only from last month, we would like to do this still as a minor release. We will have a v2 following quite soon and can start strict semantic versioning with that version.

Copy link

@sateeshperi sateeshperi left a comment

Choose a reason for hiding this comment

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

please see comments about local modules. Would also be great if they are unit tested with nf-tests. is this something you can work on adding before release ?

@@ -3,6 +3,51 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [[1.4.0](https://github.com/nf-core/pixelator/releases/tag/1.4.0)] - 2024-12-13

Choose a reason for hiding this comment

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

update date before release

@@ -12,6 +12,7 @@ of [`pixelator`](https://github.com/PixelgenTechnologies/pixelator).

The pipeline consists of the following steps:

- [Pipeline information](#pipeline-information) - Report metrics generated during the workflow execution

Choose a reason for hiding this comment

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

best to list these steps in the order of execution

(see `--multiplet_recovery`). These new component IDs are then stored in the "component" column. The information to keep track of the original and
newly recovered components are stored in a file (components_recovered.csv).
This file is not included in the output folder by default, but can be included by passing `--save_recovered_components`.
(see `--multiplet_recovery`). These new component IDs are then stored in the "component" column.

Choose a reason for hiding this comment

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

stored in column where ?


process PIXELATOR_COLLECT_METADATA {
label 'process_single'
cache false

conda "bioconda::pixelator=0.18.2"
conda "bioconda::pixelator=0.19.0"

Choose a reason for hiding this comment

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

best to follow the standard practice of putting the package info in an environment.yml and provide that

@@ -70,8 +65,7 @@ process PIXELATOR_COLLECT_METADATA {
parameters: params
]

def nextflowJson = JsonOutput.toJson(metadata)

def nextflowJson = groovy.json.JsonOutput.toJson(metadata)

Choose a reason for hiding this comment

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

need to collect version info from this module

contributors = [
// TODO nf-core: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
[
name: 'Pixelgen Technologies AB',

Choose a reason for hiding this comment

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

update contributor info

doi = '10.1101/2023.06.05.543770'
}

// Load modules.config for DSL2 module specific options
includeConfig 'conf/modules.config'

Choose a reason for hiding this comment

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

don't need modules.config ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants