Skip to content

docs: add group parameter heading#846

Merged
jfy133 merged 4 commits intonf-core:devfrom
vinisalazar:patch
Aug 15, 2025
Merged

docs: add group parameter heading#846
jfy133 merged 4 commits intonf-core:devfrom
vinisalazar:patch

Conversation

@vinisalazar
Copy link
Copy Markdown
Contributor

@vinisalazar vinisalazar commented Aug 12, 2025 •
edited
Loading

Describes how the group parameter works. Closes #839.

Edit: I hope I'm describing it correctly! That's my understanding at least, please don't hesitate to correct me.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/mag branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@vinisalazar
docs: add group parameter heading
f03ee05 
  Describes how the `group` parameter works. Closes #839.
@nf-core-bot
Copy link
Copy Markdown
Member

nf-core-bot commented Aug 12, 2025

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.2.1.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

@vinisalazar vinisalazar mentioned this pull request Aug 12, 2025
Closed
11 tasks
jfy133
jfy133 reviewed Aug 13, 2025
View reviewed changes
Comment thread docs/usage.md Outdated
@jfy133 jfy133 changed the base branch from main to dev August 13, 2025 13:46
jfy133
jfy133 approved these changes Aug 13, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Couple of phrasing/clarifications from me - if you agree with them!

Otherwise ready to merge - thanks @vinisalazar !

Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
prototaxites
prototaxites reviewed Aug 13, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@prototaxites prototaxites left a comment

Choose a reason for hiding this comment

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

A couple of points + some grammatical things

Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
@vinisalazar
Copy link
Copy Markdown
Contributor Author

vinisalazar commented Aug 14, 2025 •
edited
Loading

Thanks @jfy133 and @prototaxites !

PS: had to force-push to amend the commit to fix a typo in L67.

@vinisalazar @prototaxites @jfy133
docs: editing group description
40e3cef 
Apply suggestions from code review (#846)

Co-authored-by: Jim Downie <[email protected]>
Co-authored-by: James A. Fellows Yates <[email protected]>
jfy133
jfy133 reviewed Aug 15, 2025
View reviewed changes
Comment thread docs/usage.md Outdated
@jfy133 jfy133 merged commit 478d55f into nf-core:dev Aug 15, 2025
4 checks passed
@jfy133
Copy link
Copy Markdown
Member

jfy133 commented Aug 15, 2025

Thanks @vinisalazar

And I just realised I forgot to ask you to:

  1. Update changelog
  2. Add yourslef to contributor list on the README

🤦‍♂️

Do you mean adding a follow up PR to add those two bits?

@vinisalazar vinisalazar deleted the patch branch August 15, 2025 05:54
@vinisalazar
Copy link
Copy Markdown
Contributor Author

vinisalazar commented Aug 15, 2025

Thank you for the review! Excited to become a contributor to this pipeline.

Will make a follow-up PR shortly

@vinisalazar vinisalazar mentioned this pull request Aug 15, 2025
Merged
8 tasks
harper357 pushed a commit to harper357/mag that referenced this pull request Oct 7, 2025
@vinisalazar @prototaxites
@jfy133 @harper357
docs: editing group description
b4d8295 
Apply suggestions from code review (nf-core#846)

Co-authored-by: Jim Downie <[email protected]>
Co-authored-by: James A. Fellows Yates <[email protected]>
harper357 pushed a commit to harper357/mag that referenced this pull request Oct 7, 2025
@vinisalazar @harper357
Update CHANGELOG.md and README.md
c68b83d 
Follow-up to nf-core#846.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@prototaxites prototaxites prototaxites left review comments

@jfy133 jfy133 jfy133 approved these changes

@d4straub d4straub Awaiting requested review from d4straub d4straub is a code owner

@muabnezor muabnezor Awaiting requested review from muabnezor muabnezor is a code owner

@dialvarezs dialvarezs Awaiting requested review from dialvarezs dialvarezs is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Documentation of group parameter in samplesheet

5 participants

@vinisalazar @nf-core-bot @jfy133 @prototaxites @d4straub