Code Monkey home page Code Monkey logo

fair-cheatsheets's Introduction

🌟 This project is work in progress. All feedback is welcome in the issue tracker or as comments on the cheatsheets. 🌟

FAIR Cheatsheets

Welcome to our cheatsheets designed to assist you in enhancing the FAIRness of your research data and code! ✨

We understand how challenging it can be for researchers to make your research outputs Findable, Accessible, Interoperable, and Reusable (FAIR). Nevertheless, the significance of ensuring the FAIRness of your data and code cannot be overstated, as it directly impacts the transparency and influence of your research.

To simplify this task, we've put together a series of cheatsheets that provide easy-to-follow instructions for making your research outputs FAIR. Whether you're embarking on your journey in data and code publication or seeking to enhance your current practices, these cheatsheets provide actionable guidance that you can readily implement. The cheatsheets cover a range of topics, including data and code sharing, metadata, READMEs, and licensing. Additionally, we've included links to supplementary resources and tools that can further support you throughout your FAIRness journey.

Data          Data

  Code          Code

Specialised cheatsheets

As an extension of the Data & Code cheatsheets, we introduce the specialised cheatsheets! The specialised cheatsheets are created for researchers who want to publish data and code for more specific methods or fields. The very first specialised cheatsheet focuses on eye tracking data & code to support researchers on findability, privacy and interoperability. Use the Eye Tracking cheatsheet for further guidance to publish your eye tracking data & code!

Data

Contributions are welcome! ⭐

In order to advance this project of the FAIR cheatsheets, your contributions are very much appreciated. 🙌 Possible ways get yourself involved are:

Contribute to data or code cheatsheet 📝

  • Add or improve FAIR "actions"
  • Textual improvements
  • Add references

Create a new FAIR cheatsheet using the template 📄

  • Create a FAIR cheatsheet for your specific output based on this template
  • Make topic-specific cheatsheets

Use this template to get yourself started:

Template        Template

For a more in-depth guide on how to contribute, visit the contributing.md on this GitHub page

License

The FAIR cheatsheets are published under the CC-BY license.

fair-cheatsheets's People

Contributors

anqiedong avatar j535d165 avatar laurabengel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

fair-cheatsheets's Issues

Cheatsheet FAIRcode: why only Zenodo?

I was wondering why the cheatsheet for FAIRcode specifies specifically to use Zenodo instead of just any repository that allows file upload. The Zenodo integration might be nice for Zenodo to 'automatically' pickup any release made on Git and publish it, but it basically just made a download of the master branch released and uploaded it to Zenodo. Such actions can simply be done manually (download zip of master branch and upload zip wherever is possible). In that way it might be much simpler for those that want to upload their Git main with associated data (if code was relatively small and associated with data to analyse and process) in 1 repository (Yoda, 4TU, DANS, depending on file sizes DatVerse, etc) and results in less doi cluttering. But if the automatic integration is a key aspect, I believe 4TU.ResearchData also have their own integration with GitHub. And what about people not using GitHub but another Git instance (GitLab, BitBucket, etc), or are just not using Git at all but still have code or scripts they want to publish? What if someone made a release but wasn't meant as a release or sensitive information was accidentally present that should be removed, the automatic integration published it with a DOI and Zenodo can be a bit picky in retracting which may be an issue with accidental sensitive information:
image
This can be avoided by keeping manual control of the process.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.