Citing Research Objects#

You should cite research objects directly in the paper in places where it is relevant. This is a commonly practised way of citing publications and is valid for citing other research components like data and software. A citation includes the following information:

  • Author

  • Title

  • Year of publication

  • Publisher (for data, this is often the data repository where it is housed)

  • Version (if indicated)

  • Access information (a URL or DOI)

A citation style is a specific arrangement, order and formatting of information necessary for a citation. For instance, the MLA style was developed by Modern Language Association (originally used in the humanities) and the APA style was developed by American Psychological Association (originally used in psychology and the social sciences).

  • MLA citation style uses the following format: Author. "Title of the Source." Title of the Container, Other contributors, Version, Number, Publisher, Publication date, Location.

  • APA citation style uses the following format: Author. (Year). Title of data set (Version number). [Retrieved from] ***OR*** [DOI]

See Scribbr Citation Styles Guide. See also FORCE11 resource.

Citing Data#

When sharing a dataset, use the assigned DOI (from the data repository) and add this to your data availability statement at the end of the paper (similar to the acknowledgement section). It is important to also cite your dataset in the references themselves, as only the citations in the reference section will contribute to citation counts. Data citation is important because it facilitates access, transparency and potentially reproducibility, reuse, and credit for researchers. It also provides recognition and visibility for the repositories that share data.

You can find examples of these statements in the publishers’ (research data) author policies.

Data availability statement examples:#

Using the Digital Object Identifier (DOI): “The data that support the findings of this study are openly available in [repository name] at http://doi.org/[doi].”

If no DOI is issued:

  • “The data that support the findings of this study are openly available in [repository name] at [URL], reference number [reference number].”

When there is an embargo period you can reserve your DOI and still include a reference to the dataset in your paper:

  • “The data that support the findings will be available in [repository name] at [URL / DOI] following a [6 month] embargo from the date of publication to allow for the commercialisation of research findings.”

When data cannot be made available:

  • “Restrictions apply to the data that support the findings of this study. [Explain nature of restrictions, for example, if the data contains information that could compromise the privacy of research participants] Data are available upon reasonable request by contacting [name and contact details] and with permission of [third party name].”

  • “The data that support the findings of this study are available upon request. Access conditions and procedures can be found at [URL to restricted access repository such as EASY.]”

When code is shared:

More Data Availability Statement examples:

You can find more examples on the Manchester’s Data Access Statements page, the Cambridge Data Availability Statement examples, the AMS Data Availability Statement examples, or Nature’s Tips for writing a dazzling Data Availability Statement.

Citing Physical Samples#

When sharing results related to physical samples, ideally a persistent identifier is assigned to track the samples and their associated data. As with data citation, you include a citation in the references and a more detailed explanation in the data availability statement. To learn more about how to cite physical samples and to check out examples, see the Scientific Author Guide for Publishing Open Research Using Physical Samples by [DRS+24].

Citing Software#

A software citation has a lot of the same elements as a data citation, described above, and are described in more detail in the Software Citation Principles. When using others software, it is vital to cite and attribute it properly. See also How to Cite R and R Packages for more information.

To make your code citable, you can use the integration between Zenodo and GitHub.

  • Create a file to tell people how to cite your software. Use this handy guide to format the file.

  • Link your GitHub account with a Zenodo account. This guide explains how.

  • You can tell Zenodo what information or metadata you want to include with your software by converting your CITATION.cff file to zenodo.json.

    pip install cffconvert
cffconvert --validate
cffconvert --format zenodo --outfile .zenodo.json

  • Add .zenodo.json to your repository.

  • On Zenodo, flip the switch to the ‘on’ position for the GitHub repository you want to release.

  • On GitHub, click the Create a new release button. Zenodo should automatically be notified and should make a snapshot copy of the current state of your repository (just one branch, without any history), and should also assign a persistent identifier (DOI) to that snapshot.

  • Use the DOI in any citations of your software and tell any collaborators and users to do the same!

To make your code citable, through an automated publication of your Gitlab repository to Zenodo:

  • Create a file to tell people how to cite your software. Use this handy guide to format the file.

  • Convert your CITATION.cff file to .zenodo.json. This file tells Zenodo what information or metadata you want to include with your software.

    pip install cffconvert
cffconvert --validate
cffconvert --format zenodo --outfile .zenodo.json

  • Add .zenodo.json to your repository.

  • Use the gitlab2zenodo package to publish a snapshot of your repository to your Zenodo instance. By following the installation and setup instructions of this package, you will get a workflow on your CI that will take care of the publication to Zenodo.

  • Use the DOI in any citations of your software and tell any collaborators and users to do the same!

Note

If you don’t have a Zenodo record for your software yet when you attempt to publish it for the first time, you may encounter an error due to the undefined ID. To address this issue, we recommend manually creating a record on Zenodo and updating the value of the CI variable zenodo_record. Detailed instructions for this process can be found in the gitlab2zenodo installation and setup instruction.