Steps for Making Research Objects Citable
Steps for Making Research Objects Citable¶
There are many reasons why authors don’t cite the data and software that they use, but one of the biggest ones is that it’s not clear how. You can go a long way to reducing this barrier by following a few steps to make it as easy as possible.
1. Identify Your Research Objects¶
We want to emphasise that most of our research objects should be shared so that other researchers can reproduce and reuse them. Therefore, the first step is to identify all the research components that you would share online. Practising open research isn’t essential to get credit for your data or software, but it makes it much easier for others to build on your work in a way that acknowledges your contribution. There is a growing body of evidence that shows open research tends to be cited more than non-open research of equivalent quality and significance.
As part of the citation for your research objects, it is important to publish research objects beyond papers, such as images, data, software, protocols, methods ang workflow associated with your research.
The best way to get started with this will be to look up some examples of what kind of research objects are or should be cited. Finding commonly referenced research objects in your discipline serves two purposes:
It demonstrates that software & data are things that can be cited;
It gives authors a reference and format that they can copy and paste directly into their document.
2. Publish your work online¶
Online publications are attached to persistent identifiers that are used for citing them. It’s important to note that not everything published online gets a unique identifier but it is important that research objects are published online with DOIs as described below.
Unique identifiers or persistent links for digital objects are more formally called Digital Object Identifiers or DOIs. Using DOIs makes it much easier for others to cite your data, reduces the risk of link rot and means you can track how your research is being used and cited.
Servers that provide DOIs¶
Independent of the paper, different research objects can be published online on servers that offer DOIs. Some of these servers are Zenodo and FigShare (for different objects such as figures, presentations and reports), Data Dryad (for data), Open Grants (for grant proposals) and Open Science Framework (OSF) (for different components of an open research project).
It’s perfectly possible to cite a dataset or software package directly, and most major publishers now permit this in their style guides. However, it can sometimes help to have a more conventional paper to cite, and this is where software and data journals come in. These journals are similar to methods journals, in that they tend not to include significant results but instead focus on describing data and software in sufficient detail to allow reuse. Some examples include:
3. Add Machine-Readable Referencing Information¶
You can go a step further by allowing people to import information about your research objects into their preferred referencing database.
If BibTeX is popular in your field for managing references, post a
.bib file of all your outputs (not just your papers).
If Endnote is more popular, make an Endnote export available.
If you use GitHub, GitLab or a similar public repository, consider creating a
CITATION.cff file in each repository, which will describe how someone can refer to different research outputs from your project.
You can read more about
CITATION.cff in Software citation with CITATION.CFF.
If possible, provide several formats: you won’t need to update these very often and it will pay off.
Many online tools allow exporting citation of research objects in different formats. For example, see https://www.citethisforme.com/.