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

Add nf-prov #1259

Merged
merged 2 commits into from
Sep 29, 2023
Merged

Add nf-prov #1259

merged 2 commits into from
Sep 29, 2023

Conversation

maxulysse
Copy link
Member

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/sarek 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).

@github-actions
Copy link

github-actions bot commented Sep 29, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 96f4f20

+| ✅ 147 tests passed       |+
#| ❔   8 tests were ignored |#
!| ❗   1 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in WorkflowSarek.groovy: Optionally add in-text citation tools to this list.

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.10
  • Run at 2023-09-29 07:38:51

@FriederikeHanssen
Copy link
Contributor

should we test it a bit first before adding to the patch release?

@maxulysse maxulysse mentioned this pull request Sep 29, 2023
4 tasks
@@ -328,6 +329,10 @@ dag {
enabled = true
file = "${params.outdir}/pipeline_info/pipeline_dag_${trace_timestamp}.html"
}
prov {
enabled = true
file = "${params.outdir}/pipeline_info/manifest_${trace_timestamp}.bco.json"
Copy link
Contributor

Choose a reason for hiding this comment

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

Why manifest_${trace_timestamp}.bco.json? What does that mean?

Copy link
Member Author

@maxulysse maxulysse Sep 29, 2023

Choose a reason for hiding this comment

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

.bco because BCO format

Copy link
Contributor

Choose a reason for hiding this comment

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

Bitstream Compressed Outline Font file?

Copy link
Contributor

@adamrtalbot adamrtalbot Sep 29, 2023

Choose a reason for hiding this comment

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

Ah biocompute object. That's not obvious, let's add some documentation.

I'm not a fan of generic names like manifest_*_bco.json, I'd prefer it to be ${workflow.sessionId}.bco.json but that feels like a separate issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

comment on nf-core/tools#2455

@@ -328,6 +329,10 @@ dag {
enabled = true
file = "${params.outdir}/pipeline_info/pipeline_dag_${trace_timestamp}.html"
}
prov {
enabled = true
Copy link
Contributor

Choose a reason for hiding this comment

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

Could add a parameter for disabling it here? params.provenance?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's what I said to @ewels and he said, you'd just need to add
prov.enabled = false in a config file to disable, so no need for a params.
And I kind of agreed because that's what we do with the other reports

Copy link
Contributor

Choose a reason for hiding this comment

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

that's fair enough. I believe --prov.enabled false might work as well?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd say no, prov is a nextflow thingy, so -prov false maybe?

@maxulysse
Copy link
Member Author

should we test it a bit first before adding to the patch release?

It's been tested already ;-)

@maxulysse
Copy link
Member Author

should we test it a bit first before adding to the patch release?

It's been tested already ;-)

@jfy133 reports that it works in taxprofiler: nf-core/tools#2455 (comment)

@FriederikeHanssen
Copy link
Contributor

ok fine. Just didn't want to break the patch :D

Copy link
Contributor

@FriederikeHanssen FriederikeHanssen left a comment

Choose a reason for hiding this comment

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

although feels like it should then be 3.4

@maxulysse maxulysse merged commit ffda6bb into nf-core:dev Sep 29, 2023
20 checks passed
@maxulysse
Copy link
Member Author

although feels like it should then be 3.4

We can discuss that in the prepare release PR

@maxulysse maxulysse deleted the nf-prov branch September 29, 2023 10:01
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.

3 participants