Skip to content

Release 1.0.0#42

Merged
nh13 merged 47 commits intomasterfrom
dev
May 23, 2024
Merged

Release 1.0.0#42
nh13 merged 47 commits intomasterfrom
dev

Conversation

@nh13
Copy link
Copy Markdown
Member

@nh13 nh13 commented May 20, 2024

PR checklist

  • Changes for release 1.0.0
  • 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/fastquorum branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile 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).

brentp and others added 30 commits January 15, 2023 09:14
Adding test config with new test-datasets.  See:
  nf-core/test-datasets#1200
Also added `publishDir` for modules
Co-authored-by: Matt Stone <matthew.stone12@gmail.com>
A sample may have multiple rows in the sample sheet, for example when
data are sequenced across lanes, or across runs.  Typically this is done
to increase coverage as well as improve coverage uniformity (through
pooling samples and splitting them across lanes/sequencers).

The workflow will now process the individual lane/runs independently up
through alignment of the raw reads.  The aligned reads across lane/runs
for a given sample will be merged prior to grouping by UMI, to ensure
that reads across lanes/runs that observe the same source molecule are
grouped correctly (together).  The independent processing up through
alignment is preferred over concatenating FASTQs as this allows for
further parallelism in the processes up through alignment of raw reads.
@github-actions
Copy link
Copy Markdown

github-actions bot commented May 20, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 5505168

+| ✅ 167 tests passed       |+
#| ❔   8 tests were ignored |#
!| ❗   4 tests had warnings |!
Details

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 1.0.0
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in output.md: Write this documentation describing your workflow's output

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-05-23 18:45:48

@SPPearce
Copy link
Copy Markdown
Contributor

I would like to see the atomic fgbio modules being used from the nf-core modules repository, rather than the local modules here. This also includes using the most recent version (2.2.1).
I have started work on updating them in the main repo: nf-core/modules#5624

@nh13
Copy link
Copy Markdown
Member Author

nh13 commented May 21, 2024

@SPPearce how would you feel having this PR not blocked by the using the fgbio modules from nf-core, given I want to release by EOW so that I can include "We have a first release" for my talk at the Nextflow Summit later this week?

I think the pipeline is functionally working, the update your proposing could be for the next minor version?

Copy link
Copy Markdown
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

Some feedback.
It would be nice to sync the modules up before the release, but it isn't a dealbreaker for me. Would give you the most recent version of fgbio too (although there is a mulled container to deal with, which there should be a different way to deal with soon). I have updated all the modules on the PR, if you want to take a look at that PR at some point.

The docs/output.md file is a bit light on content at the moment.

Copy link
Copy Markdown

@edmundmiller edmundmiller left a comment

Choose a reason for hiding this comment

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

LGTM! A few small things that could just be TODOs.

Agree with @SPPearce on those. I think an issue to track some of the things brought up from the reviews to keep track of them.

Hopefully the containers and updates will be automated soon, and there will be some motivation to move the fgbio modules to nf-core modules.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nf-fastquorum_subway_desc_alt
nf-fastquorum_subway_alt

Top is the description version following similar scheme
Bottom is IMO easier to read (because no tilty text, and L-T)

SVGs if you want them/tweak them etc.

fastquorum_subway_.zip

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.

These look so much better than the really dark ones.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ditto, I may play around with them, thank-you!

Co-authored-by: Simon Pearce <24893913+SPPearce@users.noreply.github.com>
@nh13
Copy link
Copy Markdown
Member Author

nh13 commented May 23, 2024

I am going to way for the beautiful final diagrams from @jfy133 (and I'll make sure to add to the CHANGELOG with credit). But then I think we're good to go!

@nh13 nh13 merged commit 91643fd into master May 23, 2024
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