Is there any documentation for the `nf-prov` plugi...
# nextflow-plugins
u
Is there any documentation for the
nf-prov
plugin? I found the github repo for it, but the README is rather sparse on details. Specifically, what does the provenance report that it generates look like, what (meta)data does/doesn’t it collect?
p
Nothing other than the readme currently. But yes you're right, we should probably write up some more docs. Might even be worth whipping up a small mkdocs site for it. Maybe @Ben Sherman and I can take a look at that when we get some time (eg. after the Boston summit 😅 )
b
for now the easiest way to see it is to run a small pipeline like
nextflow-io/rnaseq-nf
with the reports enabled and inspect them
👍 1
u
@Phil Ewels - that would be awesome. I came across it and wanted to read up on it before recommending to a customer. They would have similar needs.
p
Yup, we will get to it ASAP (it'll likely be a few weeks at a minimum though, lots on at the moment).
It's a poor excuse for documentation, but the PR that added BCO support has some examples in the mean time at least: https://github.com/nextflow-io/nf-prov/pull/3#issuecomment-1738351440
👍 1