Attention une mise à jour du serveur va être effectuée le lundi 17 mai entre 13h et 13h30. Cette mise à jour va générer une interruption du service de quelques minutes.

Commit bb94ee3c authored by Mikaël Salson's avatar Mikaël Salson

Merge branch 'doc/4532-dev-germline' into 'dev'

Developer documention on germlines

Closes #4532

See merge request !894
parents 2d1237b5 eeda3054
Pipeline #210990 passed with stages
in 9 minutes and 25 seconds
# Germline genes
Vidjil-algo can use [](custom germline presets).
This developer documentation focuses on updating or adding the *default* germline files.
The germlines are compiled with `germline/`.
They come from various sources:
See in particular the [data updates](
- Genomic sequences through the [NCBI E-utilities API]
- A few static files
It is advised to regularly retrieve the new sequences.
However doing so may break some tests and requires some time and to fix things by hand.
### On a `feature-g/` branch
We first prepare germlines on a `feature-g` branch.
First you need to retrieve the new germlines.
From the `germline/` directory of Vidjil:
- run `make get-all-data`
- run `make diff-from-saved` to see what changed since the previous release
Take inspiration from this diff to write an insightful commit message.
- when we add new features/germline pre-processing, we add tests to `germline/tests`
It is also advised to work on tests on the algorithm (see below), but, at this stage, this is not enforced.
When a pipeline from a `feature-g` succeeds, a `.tar.gz` is uploaded to <>
with an id such as `2021-01-21`.
### On a `feature-a/` branch
- Put the new germline id in `germline/germline_id` (and also in `germline/homo_sapiens.g`)
- Then `make germline` will retrieve from <> the new germlines
- From the root directory, run a `make test` and possibly update the tests
(and possibly `make diff-from-saved`)
### 10-md5-germlines.should
You also have to generate the md5 of the germline data. For that purpose:
``` bash
# To be launched in the germline directory
rm -f ../algo/tests/should-get-tests/10-md5-germline.should
echo > ../algo/tests/should-get-tests/10-md5-germline.should
echo "$ Check md5 in germline/, sequences split and processed from germline and other databases" >> ../algo/tests/should-get-tests/10-md5-germline.should
md5sum */???[VDJ].fa | sed -r 's/^/1:/;s/\s+/ /g;' | sort -k 2 >> ../algo/tests/should-get-tests/10-md5-germline.should
echo >> ../algo/tests/should-get-tests/10-md5-germline.should
echo "$ Check md5 in germline/, other sequences" >> ../algo/tests/should-get-tests/10-md5-germline.should
md5sum */CD*.fa */???[VDJ]+{up,down}.fa */IGK-*.fa */TRDD[23]*.fa */IG*=*.fa | sed -r 's/^/1:/;s/\s+/ /g;' | sed "s/[+]/./" | sort -k 2 >> ../algo/tests/should-get-tests/10-md5-germline.should
# Then check the differences with 'git diff' and/or use 'git commit -p'
On some systems, `md5sum` should be replaced by `md5 -r`.
......@@ -47,8 +47,8 @@ sequencing methods and software, called either Rep-Seq or AIRR-Seq.
These documentations and additional developer and maintainer documentation
are available from the [doc/]( directory in the source files,
including development notes on Vidjil-algo (``)
and on the web application client (``) and the server (``).
including development notes on Vidjil-algo (``), on the germlines (``),
on the web application client (``), and on the server (``).
### Further help
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment