Code Monkey home page Code Monkey logo

infectious-diseases-toolkit's Introduction

theme badge Validation of the tools and page metadata Jekyll site CI

IDTk logo

Infectious Diseases Toolkit (IDTk)

The Infectious Diseases Toolkit (IDTk) is a community effort to detail best practices related to infectious disease data management, and showcase solutions that were developed to deal with outbreaks. It was created as part of the BeYond COVID (BY-COVID) project. More information can be found in the about page.

Contribute

IDTk is an open community project and if you'd like to help with this project, please check out the following pages for more information:

The content of the material is developed in Markdown and a templating system (Jekyll) is used to format the Markdown pages and generate a website at (https://www.infectious-diseases-toolkit.org). However, there are multiple ways to contribute, and it is not a requirement that you are able to use these systems in order to contribute!

How to reach us

Have a suggestion or spotted an error?

IDTk is a BY-COVID project

The BY-COVID project aims to make COVID-19 data accessible not only to researchers, but to anyone that to anyone that could benefit from it, such as policy makers or hospital staff.

Going beyond SARS-CoV-2 data, the project will provide a framework for making data from other infectious diseases open and accessible to everyone.

Licence

The documents and data from the IDTk are made available under a CC-BY licence. Software are made available under an MIT license. More information about our licence can be found on our licence page.

How to cite the IDTk

We have not published the story of IDTk yet. Until then, please refer to:

Infectious Diseases Toolkit. A deliverable from the EU-funded BY-COVID project (grant agreement number 101046203). URL: https://www.infectious-diseases-toolkit.org/.

All of the material from the IDTk is made publicly available under Open Source Initiative licences. The process documents and data are made available under a CC-BY license. Software is made available under an MIT licence. For full details on licensing, please see our licence document.

Acknowledgements

The IDTk is developed as part of the project BY-COVID, which received funding from the European Union’s Horizon Europe Research and Innovation Programme (grant number: 101046203). It is built based on experience and ways of working from the RDMkit, and makes use of the ELIXIR Toolkit Theme for deployment.

infectious-diseases-toolkit's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

infectious-diseases-toolkit's Issues

Quality control - Human clinical and health data

What topic do you wish to add?
Quality control measures for human health and clinical data.

To which existing Infectious Diseases Toolkit page should the topic be added to?
Human clinical and health data > Quality control page

Context
Collect feedback from the baseline use case.

Adding a note for users of Ruby 3.x

Link to the page of interest
https://www.infectious-diseases-toolkit.org/contribute/working-with-git

Describe what you would like to change on the page
In the section "Run using Jekyll directly" , step 5 it says run bundle exec jekyll serve. If you're on Ruby 3.x I think you might run get an error like:

bundler: failed to load command: jekyll (/Users/cookm/.rbenv/versions/3.1.3/bin/jekyll)
/Users/cookm/.rbenv/versions/3.1.3/lib/ruby/gems/3.1.0/gems/jekyll-3.9.3/lib/jekyll/commands/serve/servlet.rb:3:in `require': cannot load such file -- webrick (LoadError)

See this issue: jekyll/jekyll#8523. As noted in the issue, the solution is to add webrick: bundle add webrick. So maybe we should add that in point 5: "If this command returns an error, try running bundle add webrick' before trying bundle exec jekyll serve again (see this issue)." @bedroesb I guess this is the "compatibility issue" mentioned in the introduction to this section of the page? Or maybe there are more issues!

Showcase page: Linked Cohort Data

What topic do you wish to add?
Linked Cohort Data page

Are there existing pages in the Infectious Diseases Toolkit website related to the requested page?
No - test page in sandbox. More work being done in the Google Doc.

Use hyphens instead of underscores in the url

Google, one of the main search engines, prefers hyphens instead of underscores in the url for better interpretation. With RDMkit we are to late in changing this, but with IDTk we are still in time, since the website is still under construction.

Do we go ahead and change this?

Add Code of Conduct group

On the Code of Conduct page at /CODE_OF_CONDUCT.
Pending decision on who are the members of the Code of Conduct Group

Put a holding message in empty pages?

I notice there are a lot of empty pages. That makes me think of the old customer service cliché, "Always exceed customer expectations." If we promise content and make people click for it, then perhaps we need to fulfil that promise. This seems particularly cruel on landing pages (e.g. https://www.infectious-diseases-toolkit.org/pathogen_characterisation/), where we know there is no content behind the tiles, but we don't warn people before they click.

It's true there is the "Site under construction" message on the home page, but it's not clear how far the site is "complete". I guess all the links suggested to me I could click on them and find something. If there is no content, and we want the empty pages to be live, perhaps we could at least give people information on those pages about why the content is not there. We could just repeat the box on the home page, but this also seems like a an opportunity to engage people.

Is there a rough editorial timetable that we could link to, showing when different pages should be completed? Could the Twitter link be put there, if updates are announced on Twitter? If we can't/don't want to announce updates on Twitter, what about an RSS feed or a link to visualping (https://visualping.io/) so people can see when content is added? There are also browser addons that might be useful for people. It seems a shame to present people with a white wall! Just a thought, anyway.

Editors checklist

Add to the editor's checklist - what an editor should do when a page is updated? (check RDMKit for duplicit information, etc...)

Issue on page: Website overview

I would like to report an issue on the Website overview page at /contribute/website-overview. Description of the issue:

Should all page IDs be made using - instead of _ ?

Quality control - Pathogen characterisation - Wastewater use case

What topic do you wish to add?
Quality control measures for pathogen characterisation.

To which existing Infectious Diseases Toolkit page should the topic be added to?
Pathogen characterisation > Quality control page

Context
Collect feedback from the wastewater use case.

Create a Getting Started page

A Getting Started page would contain user journey like descriptions on how certain goals could be achieved on IDTk.
These might also appear as short descriptions on how to achieve the goals defined on some of the user stories.
User stories that require navigating through multiple pages of IDTk would have the focus here.

An easy and obvious way to reach the Getting Started page would be already found on the main landing page. A suggestion given during the 2022 hackathon was to have it right below the search box and above the tiles of the website sections.

Add User Stories spreadsheet to contribute page

To further help gathering user stories at this stage of the development, the spreadsheet could be linked under the Ways of contributing of the Contribute page.

Further along in development, we would remove the link.

Data description - Pathogen characterisation

Pathogen Characterisation - data description
Need to finalise the pathogen characterisation data description page that was started at the IDTk contentathon.

Are there existing pages in the Infectious Diseases Toolkit website related to the requested page?
Initiation of new topic page

Resources
Use Google doc that in our BY-COVID folder (link not shared here).

Issue on page: Contributors

I would like to report an issue on the Contributors page at /about/contributors. Description of the issue:
The link for join us leads to the wrong url.
It should point to: https://www.infectious-diseases-toolkit.org/contribute/

add governance as topic or rephrase 'regulatory' to ELSI

Issue related to: Under 'Human clinical and health data' there is the topic 'regulatory considerations'.
When talking about data access, the common term often used is 'governance'. Depending on what you would like to cover, I would suggest to generalize the topic 'regulatory' to ELSI (ethical legal and sociological implications). Or split the topic up to the respective topics: Ethical implications, Data access governance ect.

Issue on page: News

I would like to report an issue on the News page at /about/news. Description of the issue:

Clicking on the "propose changes..." pencil icon leads to a 404 page on GitHub with the following message:
The 'elixir-europe/infectious-diseases-toolkit' repository doesn't contain the '_data/news.yaml' path in 'main'.

Make RDMkit mention in Support page more clear

On the Support page at /about/support.

A more clear distinction between what is based on RDMkit and comes from the use of the same Jekyll theme as RDMkit might make it easier for the readers to not conflate RDMkit and IDTk.

Quality control - Human biomolecular data - Disease maps use case

What topic do you wish to add?
Quality control measures for human biomolecular data.

To which existing Infectious Diseases Toolkit page should the topic be added to?
Human biomolecular data > Quality control page

Context
Collect feedback from the disease map use case.

Issue on page: Page metadata still has RDMkit nomenclature

I would like to report an issue on the Page metadata page at /contribute/page_metadata. Description of the issue:

The Related pages paragraph still uses RDMkit nomenclature for the sections. These should instead be the IDTk sections.

Change Social and economic impact category name

It has been raised that Socioeconomic data is a more fitting and recognizable title for the currently named Social and economic impact.

When there is agreement, update:

  • rename category
  • /sidebars/main.yml
  • page_ids to reflect new name. From sei to sed
  • /_config.yml
  • showcase/TEMPLATE_showcase.md
  • /TEMPLATE_page.md
  • social_and_economic_impact/index.md
  • /CODEOWNERS
  • contribute/markdown_cheat_sheet.md
  • contribute/page_metadata.md
  • contribute/editorial_board_guide.md
  • metadata of all pages
  • GitHub issue label

Create a CODEOWNERS file

This file will basically make editors responsible for certain directories/files. This means that a change against these directories/files will add the responsible editor as reviewer so he can review the changes.

Theme possibility

Instead of the gradient in the headings we could also have this:
Screenshot from 2021-12-13 11-43-43

Using

h1:after {
    content: " ";
    display: block;
    height: 4px;
    border-radius: 2px;
    background-image: $color-gradient;
    margin-top: 5px;
  }

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.