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 (customisable) 'method description' MultiQC section to pipeline template #1749

Merged
merged 24 commits into from
Sep 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
02a96ca
Add new custom groovy library to generate a methods section for MultiQC
jfy133 Aug 14, 2022
63e3df6
Changelog
jfy133 Aug 14, 2022
d9a30d5
Add to schema
jfy133 Aug 14, 2022
de682fb
Update nf_core/pipeline-template/assets/methods_description_template.yml
jfy133 Aug 17, 2022
b2c5f1e
Apply suggestions from code review
jfy133 Aug 17, 2022
6f13ab2
Apply suggestions from code review
jfy133 Aug 23, 2022
4da8e9f
Update nf_core/pipeline-template/assets/methods_description_template.yml
jfy133 Aug 23, 2022
98eacbc
Add conditional DOI
jfy133 Aug 23, 2022
51231b6
Merge branch 'method-description' of github.com:jfy133/nf-core-tools …
jfy133 Aug 23, 2022
788f4ae
Merge branch 'dev' into method-description
jfy133 Aug 25, 2022
d94c50b
Generate new screengrabs with rich-codex
github-actions[bot] Aug 25, 2022
25d73bf
Update MultiQC and insert config correctly
jfy133 Sep 8, 2022
720f8ed
Update CHANGELOG.md
jfy133 Sep 8, 2022
3edfa5f
Improve message re logo
jfy133 Sep 8, 2022
919e10a
Merge branch 'dev' of github.com:jfy133/nf-core-tools into dev
jfy133 Sep 8, 2022
5fe2e8f
Update CHANGELOG.md
jfy133 Sep 8, 2022
f19641e
Try adding custom logo path parameter
jfy133 Sep 8, 2022
e3ec6dc
Remove MultiQC logo
jfy133 Sep 8, 2022
e5dafc8
Remove MultiQC logo from pipeline
jfy133 Sep 8, 2022
19c22f2
Re-add logo
jfy133 Sep 8, 2022
b9ff86d
Update nf_core/pipeline-template/assets/methods_description_template.yml
jfy133 Sep 9, 2022
3b8c303
Generate new screengrabs with rich-codex
github-actions[bot] Sep 9, 2022
c74af01
Make DOI notice a condition
jfy133 Sep 9, 2022
710044a
Merge remote-tracking branch 'origin/dev' into method-description
jfy133 Sep 9, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

- Add `actions/upload-artifact` step to the awstest workflows, to expose the debug log file
- Bioconda incompatible conda channel setups now result in more informative error messages ([#1812](https://github.com/nf-core/tools/pull/1812))
- Update MultiQC module, update supplying MultiQC default and custom config files to module
- Add a 'recommend' methods description text to MultiQC to help pipeline users report pipeline usage in publications ([#1749](https://github.com/nf-core/tools/pull/1749))

### Linting

Expand Down
7 changes: 5 additions & 2 deletions docs/images/nf-core-bump-version.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/images/nf-core-create.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-download.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-launch-rnaseq.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-licences.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-list-rna.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/images/nf-core-list-stars.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/images/nf-core-list.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-bump-version.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-create.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/images/nf-core-modules-info.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-install.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/images/nf-core-modules-lint.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/images/nf-core-modules-list-local.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/images/nf-core-modules-list-remote.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-mulled.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-patch.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-remove.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/images/nf-core-modules-test.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading