<#2270 Add test data for the vepyr/annotate module...
# test-data
g
#2270 Add test data for the vepyr/annotate module (Ensembl 116, HG002 chr22) Pull request opened by mwiewior PR checklist Test data for a new
vepyr/annotate
module. vepyr is a Rust reimplementation of Ensembl VEP that annotates against a Parquet cache. The module is in biodatageeks/vepyr
master
ahead of an nf-core/modules PR. • I read the test-data specifications • I tried testing my module with available data and there is no compatible data in test-datasets. vepyr needs its own Parquet cache format, and no VEP cache is hosted here;
ensemblvep/vep
reads its cache from
s3://annotation-cache/
. • If I added data: I described the new files on the root
README.md
• I made sure to submit the smallest dataset possible (e.g. try .tar.gz for larger directories) Files (2.9 MB total),
data/genomics/homo_sapiens/vepyr/
| File | Size | Content | | ----------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | cache.tar.gz | 473 KB | vepyr Parquet cache (Ensembl 116, GRCh38, ensembl) trimmed to the rows annotating input.vcf.gz reads. Archived because the cache is a directory; one top-level cache/, so UNTAR strips it. | | input.vcf.gz + .tbi | 42 KB | 1,000 consecutive records of the GIAB HG002 GRCh38 v4.2.1 benchmark VCF, chr22:20572272-21735973, bcftools norm -m -both | | reference.fa.gz + .fai + .gzi | 2.3 MB | GRCh38 22:1-21745973 from Ensembl Homo_sapiens.GRCh38.dna.primary_assembly.fa (samtools faidx), bgzip | The window was picked for coverage. It has missense, HGVSp, SIFT/PolyPhen, motif and regulatory annotations, so the module test asserts on real transcript, protein and regulatory output rather than a stub. The first 1,000 chr22 records are pericentromeric and have none of these. How it was built
stage_testdata.py
(run through
stage-testdata.sh
) cuts these files from vepyr's offline HG002 chr22 test fixture: 1. It annotates the 1,000 records against the fixture cache. 2. It trims the cache to the rows that annotation read. 3. It annotates again against the trimmed cache. It writes nothing unless both runs reproduce the record-body md5 Ensembl VEP 116
--everything
produced for these records:
1d4a92b815eb6193e6f4546f4ab35978
. Checked • Files downloaded from this branch are byte-identical to the staged ones. • The module's nf-tests (
homo_sapiens - vcf - everything
and the stub) pass reading these files from this branch's raw URLs, including the
UNTAR
setup step. To rerun the module tests against this branch, from a checkout of biodatageeks/vepyr
master
(Apple Silicon shown; on x86_64 use
linux/amd64
and the
:00a5ec7681bdfa20
image). The variables are explained under "Running nf-test directly" in
nf-core-module/README.md
: cd nf-core-module VEPYR_DOCKER_PLATFORM=linux/arm64 \ VEPYR_CONTAINER=community.wave.seqera.io/library/htslib_pip_python_vepyr:d7cf9a888587f5b0 \ VEPYR_NF_TESTDATA=https://raw.githubusercontent.com/mwiewior/test-datasets/vepyr-annotate/data/ \ nf-test test modules/nf-core/vepyr/annotate/tests/main.nf.test --config dev/nf-test.config The module's
main.nf.test.snap
will be generated from the published
modules
branch URLs once this is merged, and submitted with the nf-core/modules PR. 🤖 Generated with Claude Code https://claude.ai/code/session_01JKg8s8NKnvTk8nymNNg5y1 nf-core/test-datasets
Review on #2270 Add test data for the vepyr/annotate module (Ensembl 116, HG002 chr22) Review approved by piplus2 on mwiewior's pull request LGTM! nf-core/test-datasets
Review on #2270 Add test data for the vepyr/annotate module (Ensembl 116, HG002 chr22) Review approved by jonasscheid on mwiewior's pull request Hey @mwiewior! Great stuff! LGTM Regarding using this module: We are moving to VEP + pVACtools (nf-core/epitopeprediction#362). I checked whether vepyr could replace VEP there but unfortunetely not yet. Not sure if its in the scope but, pVACtools would need • The
Wildtype
and
Frameshift
plugins (Perl, shipped with pVACtools). vepyr has no equivalent. •
--symbol --terms SO --tsl --hgvs
, optionally
--pick
. vepyr rejects unknown flags, and
--hgvs
alone is not implemented. • GRCh37 and GRCm39 caches. vepyr is GRCh38 only right now. nf-core/test-datasets
Review on #2270 Add test data for the vepyr/annotate module (Ensembl 116, HG002 chr22) Review approved by erikrikarddaniel on mwiewior's pull request There's one quite large file here. Can that be reduced would be good, otherwise fine. nf-core/test-datasets