mshadbolt / human-omics-data-sharing-field-guide

Prototype for Human Genomics Data Sharing Field Guide Website

Home Page:https://australianbiocommons.github.io/human-omics-data-sharing-field-guide/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

theme badge

Australian BioCommons Human 'Omics Field Guide

A prototype website for the WIP Human 'Omics Field Guide.

Any suggestions or contributions are most welcome!

Abstract

Human Genomics data sharing is an increasingly complex task. Researchers need to juggle legal, ethical and intellectual requirements, along with publishing and funding responsibilities. Although the majority of researchers want to do the right thing, navigating the maze of data, tool, workflow and protocol repositories; software, protocol, metadata and infrastructure standards is not an easy task. Let alone staying up to date with major genome projects and support agencies that can help them on their quest. The Human Genomics Data Sharing Field guide seeks to provide a comprehensive resource that gathers together essential information on a broad range of topics to help Australian researchers on their genomics data sharing journey.

Deployment

The website is deployed using github actions defined in the workflow here: github-pages.yml

The action is run each time a new commit is pushed to the github repository.

The actions perform two things:

  1. Extract references from the group Zotero library and save it to the _bibliography folder as references.bib
  2. Render the markdown into html and push to the gh-pages branch

The main reason for doing it this way is to allow the use of other Jekyll extensions that would not be allowed by the native github pages workflow. Specifically, this allows us to use the Jekyll Scholar extension for the display of nicely formatted citations and reference lists.

One thing to be aware of is that version 5.16.0 of the Jekyll Scholar extension needs to be used due to the elixir-toolkit-theme relying on version 3.9 of Jekyll. Later versions of the Jekyll Scholar extension use Jekyll ~>4.0. I am yet to run into any issues with using the earlier version of the extension.

attempt to update to version 2

About

Prototype for Human Genomics Data Sharing Field Guide Website

https://australianbiocommons.github.io/human-omics-data-sharing-field-guide/

License:MIT License


Languages

Language:TeX 93.0%Language:Python 3.3%Language:HTML 2.8%Language:SCSS 0.7%Language:Ruby 0.2%