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 nag to cite the pipeline in summary #382

Closed
olgabot opened this issue Sep 20, 2019 · 3 comments
Closed

Add nag to cite the pipeline in summary #382

olgabot opened this issue Sep 20, 2019 · 3 comments
Labels
template nf-core pipeline/component template

Comments

@olgabot
Copy link
Contributor

olgabot commented Sep 20, 2019

e.g. from khmer

|| This is the script load-graph.py in khmer.
|| You are running khmer version 2.1.2
|| You are also using screed version 1.0
||
|| If you use this script in a publication, please cite EACH of the following:
||
||   * MR Crusoe et al., 2015. http://dx.doi.org/10.12688/f1000research.6924.1
||   * J Pell et al., http://dx.doi.org/10.1073/pnas.1121464109
||   * A. Döring et al. http://dx.doi.org:80/10.1186/1471-2105-9-11
||
|| Please see http://khmer.readthedocs.io/en/latest/citations.html for details.
@apeltzer
Copy link
Member

Could add this to the template, yeah, but the Zenodo DOI isn't automatically added (yet!) so having/reserving that would be really cool. x-ref #319 as this would be helpful

@ewels ewels added first-timers-only template nf-core pipeline/component template labels Jan 14, 2021
@ewels
Copy link
Member

ewels commented Feb 17, 2021

I think that @drpatelh has added functionality for this in the dsl2_template branch.

Not sure on the details of how it is implemented though...

// Citation string
private static String citation(workflow) {
return "If you use ${workflow.manifest.name} for your analysis please cite:\n\n" +
"* The pipeline\n" +
" https://doi.org/10.5281/zenodo.1400710\n\n" +
"* The nf-core framework\n" +
" https://dx.doi.org/10.1038/s41587-020-0439-x\n" +
"* Software dependencies\n" +
" https://github.com/${workflow.manifest.name}/blob/master/CITATIONS.md"
}

@drpatelh
Copy link
Member

Yes, its there! Will still need to update the Zenodo ID on first release and actually add citations to CITATIONS.md but other than that it will be printed every time a pipeline is run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
template nf-core pipeline/component template
Projects
None yet
Development

No branches or pull requests

4 participants