Skip to content

GDI_Addition_IDTK-Contentathon#383

Merged
bedroesb merged 46 commits intoelixir-europe:mainfrom
BU-ISCIII:update_documentation
Feb 26, 2025
Merged

GDI_Addition_IDTK-Contentathon#383
bedroesb merged 46 commits intoelixir-europe:mainfrom
BU-ISCIII:update_documentation

Conversation

@svarona
Copy link
Copy Markdown
Contributor

@svarona svarona commented Feb 4, 2025

Update of the documentation following the contentathon. Updated files:

  • data-analysis
    • pathogen-characterisation
  • quality-control
    • human-biomolecular-data
    • human-clinical-and-health-data
    • socioeconomic-data

@svarona svarona requested review from a team and bedroesb as code owners February 4, 2025 11:02
@svarona svarona changed the title Contentathon update documentation GDI_Addition_IDTK-Contentathon Feb 4, 2025
@bedroesb
Copy link
Copy Markdown
Member

Some general points:

  • Link to the github repo of the tool where possible.
  • Link to bio.tools using the regsitry, biotools syntax (see contribute pages) and link in the url to the original tool
  • Make sure the tool name/id is a bit unique.

@jaimeozaez
Copy link
Copy Markdown
Contributor

Hi @bedroesb ! All your suggestions have been implemented. I hope everything is OK!

@bedroesb
Copy link
Copy Markdown
Member

bedroesb commented Feb 24, 2025

@jaimeozaez This is really great! dragonFlye seems to be listed with a capital:

I don't have the rights to edit this PR.

image

Hence the workflow failing

@jaimeozaez
Copy link
Copy Markdown
Contributor

@bedroesb fixed! It should now be working.

@bedroesb
Copy link
Copy Markdown
Member

Same for amrfinderPlus

@jaimeozaez
Copy link
Copy Markdown
Contributor

@bedroesb there is now the same error with amrfinderPlus. It would be great if the workflow would check all the tool names.

@bedroesb
Copy link
Copy Markdown
Member

@jaimeozaez this is a hard error from Jekyll itself, using the exact same pipeline we use to deploy. I am afraid that catching the errors is difficult. Deploying the website yourself locally or on your fork is the easiest to know in advance if there will be errors.

@jaimeozaez
Copy link
Copy Markdown
Contributor

@bedroesb this time seems that all worked well! :)

- **Reproducibility and Robustness**: Reproducibility and robustness of the biomolecular analysis methods used are crucial for ensuring the consistency and reliability of the results across different laboratories and researchers. Therefore, it is essential to evaluate the reproducibility and robustness of the methods used, including the variability of results obtained by different operators, equipment, and reagents.
- **Data Quality Assessment and Reporting**: Data quality assessment and reporting are critical for ensuring the accuracy and reliability of the results and communicating the findings to stakeholders effectively. This includes implementing appropriate data quality control measures, such as quality assessment metrics and statistical analysis, to identify and correct potential sources of error and ensure the accuracy and reliability of the data. Additionally, clear and concise reporting of the results, including appropriate data visualisation and interpretation, can help communicate the findings effectively to stakeholders.
- **Sequencing quality control**: Information and tools for the assessment of the quality of the sequencing data in the context of COVID-19 can be found in the publication by the COVID-19 Host Genetics Initiative (HGI) on the [Whole Exome/Genome Sequencing Analysis Plan](https://github.com/covid19-hg/covid19_sequencing?tab=readme-ov-file).
- **Benchmarking studies**: To obtain comparative quality assessment of the applied laboratory and analytical procedure, the participation in benchmarking studies is advised. Benchmarking studies can be performed in different ways, depending on the scientific discipline. The quality of sample processing results of aliquots from the same sample across several laboratories can be compared and reasons for quality deviations can possibly be identified. Benchmarking bioinformatics workflows can be done e.g. by providing mock genomes to the study participants and identifying those workflows that perform best in in silico identification or discovery of the respective trait in question (e.g. a variant, deletion of certain length, etc.). In the field of COVID-19, several benchmarking studies have been performed, e.g. for the sequencing of viral genomes (https://pubmed.ncbi.nlm.nih.gov/34308277/), or for benchmarking bioinformatics approaches for virus identification workflows (https://genomebiology.biomedcentral.com/articles/10.1186/s13059-024-03236-4; https://www.nature.com/articles/s41598-023-31368-3; https://www.biorxiv.org/content/10.1101/2023.08.07.552334v2.full; https://www.sciencedirect.com/science/article/pii/S138665322100175X).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last comment, I promise! :) here these long urls look a bit off when rendered.

Could you replace them with the author + date, and the DOI behind them? See example below. @jaimeozaez

image

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will also tag @svarona I think this is the only blocker anymore

@bedroesb
Copy link
Copy Markdown
Member

Don't forget to add you details to: https://github.com/BU-ISCIII/infectious-diseases-toolkit/blob/update_documentation/_data/CONTRIBUTORS.yaml So we can attribute accordingly.

@jaimeozaez
Copy link
Copy Markdown
Contributor

@bedroesb I believe everything is ready! 😊

@bedroesb
Copy link
Copy Markdown
Member

Great! Lets merge! I will push a new item immediately after.

@bedroesb bedroesb merged commit 951db1a into elixir-europe:main Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants