Include clear citation instructions

Make sure others know how to cite your software by providing clear instructions, or by using standards like the citation file format (*.CFF).

How?

You can use one, or more, of the following options to clearly indicate to users how to cite your software.

Don’t forget to also consult the Software Citation Checklist for Developers (Chue Hong et al., 2019).

Use services that render a citation for you

Formatted citations in your documentation

Adding a how-to cite section to your documentation allows you to specify exactly how you would like someone else to cite your software (Lee, 2018).

Include standard files

Standard metadata files provided alongside your software that are both human and machine-readable can include citation information.

CITATION.CFF

The Citation file format (Druskat et al., 2021) example below is from the following workflow: Price, G., & Farquharson, K. (2022). PacBio-HiFi-genome-assembly-using-hifiasm (Version 2.1.0) [Computer software]. https://doi.org/10.48546/WORKFLOWHUB.WORKFLOW.221.3

cff-version: 2.1.0
message: "If you use this workflow, please cite it as below."
authors:
  - family-names: "Price"
    given-names: "Gareth"
    orcid: "https://orcid.org/0000-0003-2439-8650"
  - family-names: "Farquharson"
    given-names: "Katherine"
    orcid: "https://orcid.org/0000-0002-9009-7453"
title: "PacBio-HiFi-genome-assembly-using-hifiasm"
version: 2.1.0
doi: 10.48546/WORKFLOWHUB.WORKFLOW.221.3
date-released: 2022-10-21

codemeta.json

A Codemeta (Jones et al., 2017) file is included for this example workflow: Kasinadhuni, N., Al Bkhetan, Z., Zakrzewski, M., Chan, K., Winter, U., & Gustafsson, J. (2023). HiFi de novo genome assembly workflow (Version 1.1.0) [Computer software]. https://github.com/AustralianBioCommons/hifi-assembly-workflow

References

1. Chue Hong, N. P., Allen, A., Gonzalez-Beltran, de Waard, A., Smith, A. M., Robinson, C., Jones, C., Bouquin, D., Katz, D. S., Kennedy, D., Ryder, G., Hausman, J., Hwang, L., Jones, M. B., Harrison, M., Crosas, M., Wu, M., Löwe, P., Haines, R., … Pollard, T. (2019). Software Citation Checklist for Developers. https://doi.org/10.5281/ZENODO.3482768
2. Price, G., & Farquharson, K. (2022). PacBio HiFi genome assembly using hifiasm v2.1. https://doi.org/10.48546/WORKFLOWHUB.WORKFLOW.221.3
3. Fouilloux, A., & Föll, M. (2021). Galaxy workflow from Galaxy 101 for everyone. Zenodo. https://doi.org/10.5281/ZENODO.5090049
4. Lee, B. D. (2018). Ten simple rules for documenting scientific software. PLOS Computational Biology, 14(12), e1006561. https://doi.org/10.1371/journal.pcbi.1006561
5. Druskat, S., Spaaks, J. H., Chue Hong, N., Haines, R., Baker, J., Bliven, S., Willighagen, E., Pérez-Suárez, D., & Konovalov, A. (2021). Citation File Format. https://doi.org/10.5281/ZENODO.5171937
6. Jones, M. B., Boettiger, C., Mayes, A. C., Arfon Smith, Slaughter, P., Niemeyer, K., Gil, Y., Fenner, M., Nowak, K., Hahnel, M., Coy, L., Allen, A., Crosas, M., Sands, A., Hong, N. C., Cruse, P., Katz, D., & Goble, C. (2017). CodeMeta: an exchange schema for software metadata. KNB Data Repository. https://doi.org/10.5063/SCHEMA/CODEMETA-2.0

Page resources