Further improvements to your project
Last updated on 2024-12-03 | Edit this page
Overview
Questions
- What other improvements can I make to make my project more reproducible?
Objectives
- Add a license to your project
- Add
howfairisbadge to your README file - Add information about how to cite your project
- Link your project to Zenodo
- Add data to your project
In this part we will add some further improvements to making your project more reproducible.
Try to prioritize what you think will be most beneficial to your project.
Add a license to your project
Pick a license and add it to the repository. Use https://choosealicense.com/ to find a license for your project. Or if you do not know, you can use Apache License 2.0, a common permissive open-source license.
Add howfairis badge to your
README file
Add the howfairis badge to your README file. Follow the
instructions on the howfairis GitHub repo
How FAIR is your project and what do you need to do to improve it? Read more about FAIR software at https://fair-software.nl/
Add information about how to cite your project.
Use cff-initializer to create a CITATION.cff file for your project.
Link your project to Zenodo.
- Create an account at Zenodo
- Link your GitHub repository to Zenodo. Follow the instructions on the page.
By publishing your repository on Zenodo, it will receive a persistent identifier. This will help to avoid link rot, and make your project more FAIR.
Add data to your project.
Make sure you are allowed to publish the data (most importantly, it should be de-identified in the case of human participants).
Publish the data in a data repository and include the link to your data set in your GitHub repository. Data repositories offer organized and structured storage and access of data, ensuring that data sets abide by the FAIR principles , allowing data are findable, accessible, interoperable, and reusable (FAIR) as much as possible.
Alternatively, you can include a data file in your GitHub repository. In case you are unable to share the data, include dummy data in the project.
Make sure all data files are saved in a sustainable file format such as .csv, and that the files and variables are properly named and clearly described.
Key Points
- There are various ways to improve the reproducibility of your project.