Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update epytope and Ensembl reference handling #213

Conversation

christopher-mohr
Copy link
Collaborator

@christopher-mohr christopher-mohr commented Oct 3, 2023

This

  • updates the epytope version to the most recent and custom container
  • changes the Ensembl (biomart) reference handling, the default reference is now the most recent for GRCh37 and GRCh38 respectively. In addition, users can now provide any valid Ensembl reference (archive) version.
  • changes the parameter name and description of the Ensembl reference parameter
  • moves the handling of the parameter from the python script to modules.config
  • ensures that methods from epytope are used if available and remove corresponding code in epaa.py

Note
The handling of the most recent Ensembl (biomart) version is now possible due to the functionality in epytope available with the most recent version. This was implemented in a way to be as adaptive as possible to DB schema changes on the Ensembl BioMart side (retrieval of field names via API etc), however with old archive versions (e.g. 2014 and 2018) there are still issues due to inconsistencies on the Ensembl side.

I will still update to the most recent template to make the linting checks happy. :)

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs- [ ] If necessary, also make a PR on the nf-core/epitopeprediction branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@christopher-mohr christopher-mohr added enhancement New feature or request do not merge labels Oct 3, 2023
@github-actions
Copy link

github-actions bot commented Oct 3, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 747341b

+| ✅ 160 tests passed       |+
!| ❗   1 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in WorkflowEpitopeprediction.groovy: Optionally add in-text citation tools to this list.

✅ Tests passed:

Run details

  • nf-core/tools version 2.10
  • Run at 2023-10-11 18:45:36

Copy link
Contributor

@jonasscheid jonasscheid left a comment

Choose a reason for hiding this comment

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

Thanks for incorporating this 🚀
I only see some minor rendering issues, else lgtm

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Show resolved Hide resolved
@christopher-mohr christopher-mohr merged commit e0d2ab9 into nf-core:dev Oct 11, 2023
14 checks passed
@christopher-mohr christopher-mohr deleted the update_pipeline_and_fix_biomart_con branch October 11, 2023 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants