profile

Dr. Heidi Seibold

Setting up a FAIR and reproducible project

Published 3 months agoย โ€ขย 2 min read

Making your research or code project FAIR (Findable, Accessible, Interoperable, Reusable) and reproducible can feel like a chore. But if you have access to the right templates and resources, it can be quite the simple and rewarding task. Let's make it easy for ourselves to do the right thing!

So today let me share some templates for setting up #FAIR and #reproducible projects. I asked folks on social media what suggestions they had and got so many that I was not able to put them all here without making everyone's head explode ;). Please do follow the respective social media links if the links here are not enough for you (especially Mastodon). Thanks to everyone who contributed to this list! ๐Ÿซถ

MASTODON
LINKEDIN
TWITTER

Please note that the following research project templates generally assume that you work with data and code. The templates for code projects further down focus on research software projects.

๐Ÿ—ƒ๏ธ Research projects

๐Ÿ“ฆ Code projects

โ€‹

Setting up a FAIR and reproducible project repository

There are a couple of building blocks that you will see in (almost) all templates above:

  • A README describing the project
  • A coherent folder structure
  • Names for files and folders that are (1) human readable, (2) computer readable, and (3) consistent

One more thing I want to mention: Since we are talking about project standards, check out the YODA principles which are a set of organizational standards for datasets used for data analysis projects.

Did you find this post useful? Please help me spread the word by forwarding it to your colleagues and friends or by sharing the newsletter website link.

Today's post is probably the richest post I've shared so far. Full of super useful templates. I hope that makes up for the past weeks of silence from my end. I was very busy and in the upcoming weeks will share with you what has kept me from writing newsletter posts. I promise: it was worth it!

All the best,

Heidi


P.S. If you're enjoying this newsletter, please consider supporting my work by leaving a tip.

Heidi Seibold, MUCBOOK Clubhouse, Elsenheimerstr. 48, Munich, 81375
โ€‹Unsubscribe ยท Preferences ยท My newsletters are licensed under CC-BY 4.0โ€‹

Already a subscriber?

Dr. Heidi Seibold

https://heidiseibold.com

All things open and reproducible data science.

Read more from Dr. Heidi Seibold

We are finally in the process of incorporating the Digital Research Academy and just when we need it least, I get a notice that my office lease will be terminated by end of July...and with that we are losing the headquarters of the DRA. Munich is a difficult city to find affordable offices, so I am hoping that you can help us. I love my office. It not only comes with a stable internet connection, but also with nice office neighbors (who are also looking for a new space), a nice view into the...

1 day agoย โ€ขย 1 min read

Students and early PhD candidates often don't understand all the talk about Open Science. They think Open Science is just "normal" science. The older researchers are the ones who teach them otherwise. Let's change that! In the process of publishing my first PhD paper, the journal asked whether I would like to publish open access. For me that was a no-brainer. When I talked to my supervisor, he said something along the lines of "you're gonna be an expensive PhD student". I want to mention that...

6 days agoย โ€ขย 3 min read

Spaces where you can gather with like minded people to discuss, learn, and collaborate can be really powerful. Could a space like this exist for Open Science? Walking along the little stream back to Dagstuhl castle (during the seminar on Research Software Engineering: Bridging Knowledge Gaps), I thought about how inspiring this place is, how perfectly set up for collaborating, learning from each other and also for having just a fabulous time. All the rooms, from the regular meeting rooms to...

13 days agoย โ€ขย 1 min read
Share this post