feat: CLIN-3686 add support for local source in exomiser #49
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for the LOCAL frequency source in exomiser.
To use this feature, you must provide the following parameters with full paths:
exomiser_local_frequency_path
exomiser_local_frequency_index_path
The index file is required if using the feature, meaning
exomiser_local_frequency_index_path
must be specified ifexomiser_local_frequency_path
is provided.Additionally, add the
LOCAL
keyword to the frequency sources definition in the exomiser analysis file.Our test setup covers the local source, so you can use it as an example.
Other change:
Tests
-Run the test profile locally:
nextflow run main.nf -profile test,docker
We should see a log message from exomiser indicating that a local frequency file is used
-Comment the line defining the exomiser_local_frequency_index_path in test configuration.
Then run the pipeline again. It should fail with a warning mentioning that the parameter exomiser_local_frequency_index_path is missing.
-Comment the LOCAL source in assets/exomiser/test_exomiser_analysis
Comment the lines defining the exomiser_local_frequency_path and exomiser_local_frequency_index_path parameters in test profile
Then run:
nextflow run main.nf -profile test,docker
The pipeline should run successfully.
We should not see the log message for the local frequency file
PR checklist
nf-core lint
).nextflow run . -profile test,docker --outdir <OUTDIR>
).nextflow run . -profile debug,test,docker --outdir <OUTDIR>
).docs/usage.md
is updated.docs/output.md
is updated.docs/reference_data.md
is updated.CHANGELOG.md
is updated.README.md
is updated (including new tool citations and authors/contributors).