Closed taylorreiter closed 1 year ago
nf-core lint
overall result: Passed :white_check_mark: :warning:Posted for pipeline commit 007dd13
+| ✅ 125 tests passed |+
#| ❔ 20 tests were ignored |#
!| ❗ 5 tests had warnings |!
re: report size, yes it will be good to keep an eye on this. I remember reading in the documentation that it's supposed to scale well with many samples, so I think that's something that has been optimized within multiqc itself. The largest report I have locally is 1.4 Mb (adair's cheese samples), so we still have quite a bit of wiggle room.
for section headers, I agree here as well. I'm going to see what people say when we run this on their data before making those changes, but def something to keep an eye out for.
This PR adds a bunch of documentation to the pipeline. a lot of it will appear inline in the multiqc output file as blue call out boxes and describe how to interpret the results. I added a zipped file of the multiqc html output so you can see what that documentation looks like inline. I think our documentation will improve over time, especially for pacbio hifi and nanopore reads.
multiqc_report.html.zip
(the sample is direct nanopore RNA seq of an ecoli)
PR checklist
nf-core lint
).nextflow run . -profile test,docker --outdir <OUTDIR>
).docs/usage.md
is updated.docs/output.md
is updated.CHANGELOG.md
is updated.README.md
is updated (including new tool citations and authors/contributors).