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

Collect tool citations #1177

Closed
ewels opened this issue May 4, 2020 · 5 comments · Fixed by #1524
Closed

Collect tool citations #1177

ewels opened this issue May 4, 2020 · 5 comments · Fixed by #1524
Assignees

Comments

@ewels
Copy link
Member

ewels commented May 4, 2020

It would be nice if there was a clear citation for specific tools in MultiQC so that users benefiting from somalier or peddy output could (be reminded to) cite the tool(s) they are using in addition to MultiQC.

Originally posted by @brentp in #1155 (comment)

@ewels
Copy link
Member Author

ewels commented May 4, 2020

Suggestions for how this could be rendered in the report are welcome!

@ewels
Copy link
Member Author

ewels commented Aug 12, 2021

I think that this would be best done by adding in a new optional argument to BaseMultiqcModule called doi. This can then be added into self.intro if it is set, using a doi.org URL:

https://github.com/ewels/MultiQC/blob/29bccd8c0d71149e4e2b18a0e95621177f92298b/multiqc/modules/base_module.py#L64-L65

@ewels
Copy link
Member Author

ewels commented Aug 12, 2021

As a bonus, would also be nice to save a citations file into multiqc_data with all of the citation info collected into one location. Could think about various formats for this.

Would be nice to include bonus content about the manuscripts, but that will require an internet connection so it must be an add on that does not degrade performance if not available. Would be fun to be able to get a pop-over when hovering on the DOI with the manuscript title / Dimensions.ai badge etc. But that's low priority compared to the rest.

@ErikDanielsson ErikDanielsson linked a pull request Aug 17, 2021 that will close this issue
2 tasks
@ewels
Copy link
Member Author

ewels commented Nov 9, 2021

@brentp - thanks again for the original suggestion, this is now implemented and merged. It'll be generally available in the next release. Let me know if you have any feedback or suggestions!

@brentp
Copy link

brentp commented Nov 9, 2021

wow! excellent work!

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 a pull request may close this issue.

3 participants