librarycarpentry/top-10-fair

Top 10 FAIR Data & Software Things

Top 10 FAIR Data & Software Things

The Top 10 FAIR Data & Software Things are brief guides (stand alone, self paced training materials), called "Things", that can be used by the research community to understand how they can make their research (data and software) more FAIR (Findable, Accessible, Interoperable and Reusable).

The Top 10 FAIR Data & Software Things is hosted by Library Carpentry and maintained by the Sprinters.

Lead Maintainers

Liz Stokes, Chris Erdmann, Juande Santander-Vela, Doug Joubert

Maintainers meet/discuss via the Team Site.

Background

Library Carpentry is a software skills training programme aimed at library and information professions. It builds on the work of Software Carpentry and Data Carpentry.

Library Carpentry is in the commons and for the commons. It is not tied to any institution of person. For more information on Library Carpentry, see our website LibraryCarpentry.org.

Contribution

There are many ways of contributing to Library Carpentry:

• Join our Gitter discussion forum.
• Follow updates on Twitter.
• Make a suggestion or correct an error by raising an Issue.

Code of Conduct

All participants should agree to abide by the Software Carpentry Code of Conduct.

Citation

Paula Andrea Martinez, Christopher Erdmann, Natasha Simons, Reid Otsuji, Stephanie Labou, Ryan Johnson, … Eliane Fankhauser. (2019, February). Top 10 FAIR Data & Software Things. Zenodo. http://doi.org/10.5281/zenodo.3409968

Kiko Theme

Kiko is a theme for Jekyll, the static site generator. It's designed and developed by @gfjaru.

See it live

top-10-fair's Issues

imaging: archiving the original data file?

Hi,
Thanks for making this available.

I am struggling with the question of archiving .nd2 files and whether I can get all metadata in a .omime.fiff. I asked here: https://forum.image.sc/t/data-archiving-what-format-to-use-which-files-to-keep/28947/11

What is your advice, should we archive both the nd2 file and a omime.tiff export, is the .nd2 file enough, is the omime.tiff file enough? Does it depend on the experiment?

Missing license

This repository appears to be missing a license. A form of a creative-commons license is probably what is needed.

Perhaps a Citation File Format CFF is also a good idea. Happy to create one with a PR.

Top 10 FAIR Data & Software Things/EOSC about open sciences

I found this lesson excellent. I would like to see the possibility to complete it with some points. In particular at the beginning by mentioning the open science initiative.

---

Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.

If this issue is about a specific episode within a lesson, please provide its link or filename.

Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at [email protected].

---

standard style for these things

We have a question about standard styles for things like links in the thing, headers levels, etc. For instance, in case of printing, do we want the link exposed so it prints.

How do we drive this thing?

With this maintainer role, I kind of feel like we've been handed the keys to a Mack Truck after doing an online driving course, and I'm worried about running over roundabouts and parked cars on my way out to the highway.

Given that we've got at least 2 self professed newbie maintainers on this repo (@ragamouf @doujouDC ) and @libcce moving jobs and relinquishing his careful and dedicated curation of this repo (which has been awesome and super helpful), I would like to have a discussion amongst the maintainers here about what it is we think we're doing, and what expectations do we have for ourselves and each other.

For example, this Top 10 FAIR repo is a different kind of beast to the lessons in the Library Carpentry stable, and I wonder if we should have a long term goal to transform these resources into something that fits more within the carpentries lesson framework? If not, why not?

Another question I have falls into the slightly cringeworthy "ok, how do I actually do this?" category. My git game is pretty beginner, and I still have a reasonable amount of anxiety doing anything on this platform. I hope by being open about this I can enable others to ask lots of entry level questions, especially where the ground seems to overlap between the shores of 'this is how you do things in git' and gentle waves of 'here are the social rules for interacting on git'. For example, would we expect any maintainer to weigh into an issue even if they had only a small grasp of the issue at hand? For this last point, I'm sure there's something in one of the handbooks about this - allow me to refer to a previous email from the everpatient @libcce! Ahah! Lesson maintainers

Alright, that's perhaps enough to start with. I had trouble assigning fellow maintainer @juandesant to this issue, but maybe that's a matter of inviting him.

Keen to hear your thoughts :-)

Reword "About" section?

[suggestion]

I noticed that the "About" section doesn't really say up-front what this is about. Since the front page just throws you a set of links to sections, "About" should really do that. It is somewhat mentioned in the text, but it is more a description of the history of this project.

An opening paragraph stating what Top-10-FAIR is about would be nice. Perhaps one or two sentences from that paragraph could be copied onto the front page as well, which saves the new visitor a click to "About"; the same sentence(s) could be copied into the README file as well.

The same goes for the page description, which is currently just a copy of the first paragraph in the "About" section (and is displayed by e.g. Google in the search results).

imaging references .bib

@katrinleinweber,
do you think you can help me with my references?
I worked with adding a bib file, it renders using pandoc (locally) but not showing the references here:
https://librarycarpentry.org/Top-10-FAIR/2019/06/27/imaging/
do you think I might need to move bib to another location?
You can find the two files here:
https://github.com/LibraryCarpentry/Top-10-FAIR/tree/master/_posts

Edit: I've used this neat guide: https://github.com/benmarwick/atom-for-scholarly-writing-with-markdown

Thank you,
Paula

FAIRsharing as a tool to make your data FAIR

Hi there, if you're still accepting changes/suggestions, may I propose we work together to include FAIRsharing in this? FAIRsharing works with the maintainers of resources to create and maintain manually curated metadata on standards (reporting guidelines, terminology artefacts, models and formats, metrics and identifier schema), databases (both knowledge-bases and repositories), and data policies (from funders and journal publishers). FAIRsharing provides this metadata to a growing ecosystem of FAIR providers, such as the FAIRshake evaluator tool, the FAIR evaluator tool (part of GO-FAIR), the Data Stewardship Wizard (part of GO-FAIR and ELIXIR), and more. FAIRsharing itself is funded by The Wellcome trust and is an ELIXIR Recommended Interoperability Resource, a member of EOSC-Life, has a working group in the RDA (which also has a recommended output), and has an implementation network in GO-FAIR.

I'd be happy to work with you to illustrate how FAIRsharing can be used to make data FAIR.

Include link to FAIR lesson

See note from @kariljordan
requesting we link to the lesson from this repo.

LibraryCarpentry/librarycarpentry.github.io#105

Integrate changes from libcce/Top-10-FAIR here

Before they diverge too much.

• PR @libcce's branch here
• resolve merge-conflicts (locally)
• delete https://github.com/libcce/Top-10-FAIR/settings
  • re-fork from here if necessary

separate domain specific content (imaging section)

hi,

I just had a rapid look at the imaging part. The information I was looking for is difficult to find, because of all the introduction about what is FAIR and so on.

I think it would be much more efficient to keep only domain specific information in there and get all generic ones in a different section. The music section seems to follow that idea...

legibility & colour contrast

I'm a recent visitor to your Top-10-FAIR page. I notice the colour contrast is very low (blue text for links on a white background and light grey text on white background). It is hard to read and probably impossible for individuals with low vision. The blue links do not met the minimum W3C WAG (Web Accessibility Guidelines Section 1.4.3) for legibility and colour contrast.

WAG: https://webaim.org/standards/wcag/checklist#sc1.4.3
WAG: https://www.w3.org/TR/WCAG21/#contrast-minimum

If you want to verify this for yourselves, there is a well respected web browser plugin tool for checking website for accessibility called WAVE (accessibility evaluation tool web), created by Utah State University, here https://wave.webaim.org/

I also find the grey text on a white background hard to read (even though it seems to pass the WAG standards). Please consider making that text darker also.

Thank you.