cfe-lab / cfe-lab/MiCall

Simplify comparison of project definitions

Open
#1,158 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
21
Forks
11
Avg merge
12h 5m
Merged PRs (30d)
24

Description

In step 4 of the release instructions in CONTRIBUTING.md, it says to download the project definitions from QAI, and compare them with the source code in projects.json and project_scoring.json. However, it looks like some recent changes have made that comparison harder.

  • The entries in the current files don't seem to be sorted, and the downloaded version is sorted. Add an option to just sort the current files without downloading them, just to help with comparisons.
  • The genotype_references key isn't downloaded, and might not be in the database at all. Either document that it can be ignored, or figure out where to download it from.
  • It looks like the extra references for the HIVGHA project (HIV1-CRF02_AG-GH-AB286855-seed and HIV1-CRF06_CPX-GH-AB286851-seed) are included in more places than they should be. Is that a bug in the download script?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with step 4 in CONTRIBUTING.md and inspect projects.json, project_scoring.json, and the download script used for the QAI definitions. Reproduce the comparison workflow, then resolve the sorting option, genotype_references handling, and HIVGHA reference placement questions. Done means the release comparison is easier and each checklist item has a documented or verified outcome.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
bioinformatics, documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.