Create a DOI for this repo with Zenodo

[JamesPHoughton]

As a researcher (possibly from another lab or institution) I want to be able to cite this repository as a resource used in my own research, so that I have clean documentation in my publications, and to express credit appropriately.

One way to do this is with Zenodo:

Documentation here: https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content
Example of DOI badge in readme here: https://github.com/JamesPHoughton/pysd, and zenodo link here: https://zenodo.org/record/6381722#.YksL4W7MJhE

We could also do it with OSF

• Spend 15-30 mins discovering the differences between the two approaches, and decide which way to go.

Ready to merge when

• DOI is created
• DOI badge is present in README.md
• Suggested citation of this repo is in README.md
• Repo contains a 'citation' file as suggested by mark.

[markwhiting]

Just wondering — is there a reasons you would use zenodo over OSF for this?

As an aside, do you think people will cite this vs the specific surveys? In the event that we create a new survey, presumably it would have its own paper, validation, and DOI etc too?

[markwhiting]

Ah, this might also be interesting → About citation files

[JamesPHoughton]

do you think people will cite this vs the specific surveys?
In the event that we create a new survey, presumably it would have its own paper, validation, and DOI etc too?

I would certainly expect that a new validated survey would have its own publication that people could cite when using it. I would probably want that publication to be able to cite this repository as the location for an implementation-of-record of the survey, and that other people might cite this repo if they end up using a number of other surveys we have implemented, or if they use our implementation of someone else's survey.

As for zenodo vs OSF, I hadn't really given it much thought. Zenodo is well integrated with github, I haven't used OSF as much. Adding a task to this issue for whoever does it to spend 15 minutes looking at the differences.

[markwhiting]

OK! I have no opinion about the OSF thing, just wondering.