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

Fix stub run in mhc binding subworkflow with new template #249

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
129 commits
Select commit Hold shift + click to select a range
b0f0d7a
Merge pull request #198 from nf-core/dev
ggabernet Mar 17, 2023
6700180
Merge pull request #211 from alina-bauer/dev
jonasscheid Aug 31, 2023
7bf589f
Template update for nf-core/tools version 2.10
nf-core-bot Sep 25, 2023
c96f84d
update to new epytope version, use biomaradapter
christopher-mohr Oct 2, 2023
090b222
adapt to epytope changes
christopher-mohr Oct 3, 2023
7a299a9
remove func, replaced by epytope method
christopher-mohr Oct 3, 2023
77d94de
remove epytope suffix from IDs
christopher-mohr Oct 3, 2023
2b68bda
replace is_created_by_variant func by eyptope
christopher-mohr Oct 3, 2023
f7ad4a1
adapt genome reference parameter and handling
christopher-mohr Oct 3, 2023
4717537
fix python package version retrieval
christopher-mohr Oct 3, 2023
4d77f93
Merge branch 'TEMPLATE' of https://github.com/nf-core/epitopepredicti…
christopher-mohr Oct 8, 2023
997d4c1
update CHANGELOG
christopher-mohr Oct 8, 2023
0583de2
change version
christopher-mohr Oct 8, 2023
1bfb74e
update modules
christopher-mohr Oct 8, 2023
9ede7ac
remove linting warnings
christopher-mohr Oct 8, 2023
f196cb1
remove deprecated param from profiles
christopher-mohr Oct 8, 2023
1cd3cb4
update docs
christopher-mohr Oct 8, 2023
b403f80
run black
christopher-mohr Oct 8, 2023
a3ccf4b
Update nextflow_schema.json
christopher-mohr Oct 11, 2023
fdb3f9d
include review suggestions
christopher-mohr Oct 11, 2023
747341b
Merge branch 'update_pipeline_and_fix_biomart_con' of https://github.…
christopher-mohr Oct 11, 2023
e0d2ab9
Merge pull request #213 from christopher-mohr/update_pipeline_and_fix…
christopher-mohr Oct 11, 2023
f9fb2fb
refactor subworkflow
jonasscheid Nov 3, 2023
2dd3e55
fix registry of external tool import
jonasscheid Nov 5, 2023
5434e04
bump version, add changes to changelog
jonasscheid Nov 5, 2023
182fa7d
Merge pull request #219 from jonasscheid/fix_external_container_registry
jonasscheid Nov 6, 2023
bab8e0a
allow vcfgz again
jonasscheid Dec 1, 2023
202fa44
fix compressed vcf parsing, refactored allele checking
jonasscheid Dec 4, 2023
2dd79dd
bump python version of samplechecker
jonasscheid Dec 4, 2023
d04e77f
add staging in samplesheet checker to determine inputtype
jonasscheid Dec 4, 2023
7868e5c
switch to nf-validation
jonasscheid Dec 5, 2023
7396472
remove conda check, threw warning
jonasscheid Dec 5, 2023
0b1358a
swtich back to old len settings
jonasscheid Dec 5, 2023
3f3bcf9
add changelog, fix lint
jonasscheid Dec 5, 2023
1ffdacb
change internal mhcclass to mhc_class for consistency
jonasscheid Dec 5, 2023
6b921c2
depricate gsvar and variant tsv
jonasscheid Dec 8, 2023
6fcac57
prettier
jonasscheid Dec 8, 2023
cbc566e
update changelog
jonasscheid Dec 8, 2023
4239b6a
remove depricated tests from ci
jonasscheid Dec 11, 2023
14a76b4
update test conigs in nextflow.config
jonasscheid Dec 11, 2023
e2e3f80
Update CHANGELOG.md
jonasscheid Dec 11, 2023
ee311d9
Merge pull request #221 from jonasscheid/depricate_gsvar_and_variant_tsv
christopher-mohr Dec 11, 2023
db037bd
resolve conflicts
jonasscheid Dec 13, 2023
400b831
Add check for mhc_class-allele combination
jonasscheid Dec 13, 2023
a34c450
Remove txt filename input from schema_input.json
jonasscheid Dec 18, 2023
74da74b
Update workflows/epitopeprediction.nf
jonasscheid Dec 19, 2023
693bd50
Update workflows/epitopeprediction.nf
jonasscheid Dec 19, 2023
ce8c16d
Merge pull request #220 from jonasscheid/fix_lost_vcfgz_support
jonasscheid Dec 19, 2023
9aef677
Template update for nf-core/tools version 2.11
nf-core-bot Dec 19, 2023
5dfb258
Template update for nf-core/tools version 2.11.1
nf-core-bot Dec 20, 2023
01fb674
updating README + name fix
Jan 18, 2024
5df6e3b
reformat
Jan 18, 2024
45e04d7
Template update for nf-core/tools version 2.12
nf-core-bot Jan 29, 2024
2e13e01
Prevent crash if no transcript is found (in splitted vcf)
jonasscheid Jan 30, 2024
e60cd71
update changelog
jonasscheid Feb 1, 2024
bfb0a55
merge template
jonasscheid Feb 5, 2024
ad38aed
fix lint
jonasscheid Feb 5, 2024
f498fc2
update changelog
jonasscheid Feb 5, 2024
07c6902
[automated] Fix linting with Prettier
nf-core-bot Feb 5, 2024
53ae332
reformat using ruff
jonasscheid Feb 5, 2024
92282af
Merge branch 'nf-core:master' into merging-template-updates
jonasscheid Feb 5, 2024
0445505
Merge branch 'merging-template-updates' of https://github.com/jonassc…
jonasscheid Feb 5, 2024
bfd98b5
update changelog
jonasscheid Feb 5, 2024
f0d8c9e
fix padding
jonasscheid Feb 5, 2024
a0e248d
Merge pull request #228 from jonasscheid/merging-template-updates
jonasscheid Feb 6, 2024
6177dc3
update changelog
jonasscheid Feb 6, 2024
a728456
Merge pull request #227 from jonasscheid/fix-bug-if-no-transcript-ava…
jonasscheid Feb 6, 2024
d9e12eb
clean up changelog
jonasscheid Feb 7, 2024
97b0c0f
clean up changelog
jonasscheid Feb 7, 2024
adc32bc
update gunzip
jonasscheid Feb 7, 2024
5e98069
bump version
jonasscheid Feb 7, 2024
e3ecb16
ignore logos for lint
jonasscheid Feb 7, 2024
3cee487
nf-core lint fix files_unchanged
jonasscheid Feb 7, 2024
15f1a46
update multiqc module
jonasscheid Feb 7, 2024
88fa817
ignore logos for linting
jonasscheid Feb 14, 2024
085c1e5
update changelog date
jonasscheid Feb 14, 2024
28400d1
Merge pull request #229 from jonasscheid/prepare-release
jonasscheid Feb 14, 2024
8e4c198
Merge remote-tracking branch 'origin/dev' into show_supported_models_fix
christopher-mohr Feb 16, 2024
b6d9cf4
Merge pull request #225 from nf-core/show_supported_models_fix
christopher-mohr Feb 16, 2024
1033fc8
clean up CI tests
christopher-mohr Feb 16, 2024
14cafe5
Merge pull request #231 from christopher-mohr/fix_ci_tests
christopher-mohr Feb 16, 2024
8691e1d
Incorporate review
jonasscheid Feb 19, 2024
49f126a
udpate changelog date
jonasscheid Feb 20, 2024
72e7e30
Merge pull request #232 from jonasscheid/prepare-release
christopher-mohr Feb 20, 2024
6f8f3c6
Template update for nf-core/tools version 2.13
nf-core-bot Feb 20, 2024
d89ce8e
merge template, fix conflicts, adjust for new local subworkflow struc…
jonasscheid Feb 22, 2024
4e232c7
fix outdated param in grch38 test
jonasscheid Feb 22, 2024
06702bb
incorporate release review requests
jonasscheid Feb 22, 2024
48eeb0f
fix readme
jonasscheid Feb 22, 2024
90349c0
fix ensembl default (grch38) url
christopher-mohr Feb 23, 2024
155b80f
add newline to readme for proper display of hyperlinks
jonasscheid Feb 23, 2024
84252c5
Merge pull request #234 from jonasscheid/prepare-release
christopher-mohr Feb 23, 2024
ed86428
Merge pull request #6 from jonasscheid/dev
jonasscheid Feb 25, 2024
40f846b
remove duplicated warning from readme
jonasscheid Feb 25, 2024
504919e
remove genome reference enum which might block specifying special bio…
jonasscheid Feb 25, 2024
7e2f470
bump release date
jonasscheid Feb 26, 2024
9e281b3
prettier readme
jonasscheid Feb 26, 2024
1b82b50
Merge pull request #235 from jonasscheid/prepare-release
jonasscheid Feb 26, 2024
377cd7f
Template update for nf-core/tools version 2.13.1
nf-core-bot Feb 29, 2024
e2b2e7a
remove view
jonasscheid Mar 22, 2024
e253f8b
prepare for release
jonasscheid Mar 22, 2024
3cee77a
Merge pull request #237 from jonasscheid/merge-template
jonasscheid Mar 25, 2024
a1e9af9
add stub to all local modules
jonasscheid Mar 27, 2024
16329c4
fix changelog date
jonasscheid Mar 27, 2024
63e13c8
revert args to argument
jonasscheid Mar 28, 2024
81fba13
Merge pull request #239 from jonasscheid/merge-template
jonasscheid Mar 28, 2024
fe1de34
Template update for nf-core/tools version 2.14.0
nf-core-bot May 8, 2024
ae1fb38
Template update for nf-core/tools version 2.14.1
nf-core-bot May 9, 2024
ee75ad3
Merge branch 'TEMPLATE' of https://github.com/nf-core/epitopepredicti…
christopher-mohr May 15, 2024
e7345fc
remove dumpsoftwareversions
christopher-mohr May 15, 2024
9170272
remove fastqc from modules.json
christopher-mohr May 15, 2024
e2cf136
update CHANGELOG
christopher-mohr May 15, 2024
673a805
update all test config input paths
christopher-mohr May 15, 2024
fe02f4d
Update CHANGELOG.md
christopher-mohr May 15, 2024
f66e334
add check to epaa, update CHANGELOG
christopher-mohr May 15, 2024
93d6500
Merge branch 'merge-template-update-2-14-1' of https://github.com/chr…
christopher-mohr May 15, 2024
16d714a
add warning if protein mapping not available
christopher-mohr May 16, 2024
0282263
Merge pull request #243 from christopher-mohr/merge-template-update-2…
jonasscheid May 16, 2024
82f4bd0
Template update for nf-core/tools version 3.0.0
nf-core-bot Oct 8, 2024
b7a1d3e
Template update for nf-core/tools version 3.0.1
nf-core-bot Oct 9, 2024
11f286b
Template update for nf-core/tools version 3.0.2
nf-core-bot Oct 11, 2024
83b8784
merge template
jonasscheid Nov 16, 2024
9a70ed4
update changelog
jonasscheid Nov 16, 2024
0f3888d
update resource handling in all test configs
jonasscheid Nov 16, 2024
f2b0db6
bump nf version in ci tests
jonasscheid Nov 16, 2024
40a4101
Merge pull request #247 from jonasscheid/template-merge-3-0-2
jonasscheid Nov 17, 2024
769213c
merge dev
jonasscheid Dec 6, 2024
6e6a4c1
etablish stub run in subworkflow, cosmetic changes
jonasscheid Dec 8, 2024
6cc5f47
stub run structure continued
jonasscheid Dec 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,15 @@
"name": "nfcore",
"image": "nfcore/gitpod:latest",
"remoteUser": "gitpod",
"runArgs": ["--privileged"],

// Configure tool-specific properties.
"customizations": {
// Configure properties specific to VS Code.
"vscode": {
// Set *default* container specific settings.json values on container create.
"settings": {
"python.defaultInterpreterPath": "/opt/conda/bin/python",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.formatting.autopep8Path": "/opt/conda/bin/autopep8",
"python.formatting.yapfPath": "/opt/conda/bin/yapf",
"python.linting.flake8Path": "/opt/conda/bin/flake8",
"python.linting.pycodestylePath": "/opt/conda/bin/pycodestyle",
"python.linting.pydocstylePath": "/opt/conda/bin/pydocstyle",
"python.linting.pylintPath": "/opt/conda/bin/pylint"
"python.defaultInterpreterPath": "/opt/conda/bin/python"
},

// Add the IDs of extensions you want installed when the container is created.
Expand Down
11 changes: 10 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@ end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset
indent_size = unset
[/subworkflows/nf-core/**]
charset = unset
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset

[/assets/email*]
indent_size = unset

# ignore python and markdown
[*.{py,md}]
indent_style = unset
21 changes: 14 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Please use the pre-filled template to save time.
However, don't be put off by this template - other more general issues and suggestions are welcome!
Contributions to the code are even more welcome ;)

> [!NOTE]
> If you need help using or modifying nf-core/epitopeprediction then the best place to ask is on the nf-core Slack [#epitopeprediction](https://nfcore.slack.com/channels/epitopeprediction) channel ([join our Slack here](https://nf-co.re/join/slack)).

## Contribution workflow
Expand All @@ -18,13 +19,19 @@ If you'd like to write some code for nf-core/epitopeprediction, the standard wor
1. Check that there isn't already an issue about your idea in the [nf-core/epitopeprediction issues](https://github.com/nf-core/epitopeprediction/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this
2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/epitopeprediction repository](https://github.com/nf-core/epitopeprediction) to your GitHub account
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
4. Use `nf-core schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
4. Use `nf-core pipelines schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged

If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/).

## Tests

You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. Execute all the tests with the following command:

```bash
nf-test test --profile debug,test,docker --verbose
```

When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.

Expand All @@ -33,7 +40,7 @@ There are typically two types of tests that run:
### Lint tests

`nf-core` has a [set of guidelines](https://nf-co.re/developers/guidelines) which all pipelines must adhere to.
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core lint <pipeline-directory>` command.
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core pipelines lint <pipeline-directory>` command.

If any failures or warnings are encountered, please follow the listed URL for more documentation.

Expand Down Expand Up @@ -68,7 +75,7 @@ If you wish to contribute a new step, please use the following coding standards:
2. Write the process block (see below).
3. Define the output channel if needed (see below).
4. Add any new parameters to `nextflow.config` with a default (see below).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core schema build` tool).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool).
6. Add sanity checks and validation for all relevant parameters.
7. Perform local tests to validate that the new code works as expected.
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
Expand All @@ -79,13 +86,13 @@ If you wish to contribute a new step, please use the following coding standards:

Parameters should be initialised / defined with default values in `nextflow.config` under the `params` scope.

Once there, use `nf-core schema build` to add to `nextflow_schema.json`.
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.

### Default processes resource requirements

Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/master/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.
Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.

The process resources can be passed on to the tool dynamically within the process with the `${task.cpu}` and `${task.memory}` variables in the `script:` block.
The process resources can be passed on to the tool dynamically within the process with the `${task.cpus}` and `${task.memory}` variables in the `script:` block.

### Naming schemes

Expand All @@ -96,7 +103,7 @@ Please use the following naming schemes, to make it easy to understand what is g

### Nextflow version bumping

If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core bump-version --nextflow . [min-nf-version]`
If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core pipelines bump-version --nextflow . [min-nf-version]`

### Images and figures

Expand Down
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/epit
- [ ] 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](https://github.com/nf-core/epitopeprediction/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/epitopeprediction _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Make sure your code lints (`nf-core pipelines lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
- [ ] Usage Documentation in `docs/usage.md` is updated.
- [ ] Output Documentation in `docs/output.md` is updated.
- [ ] `CHANGELOG.md` is updated.
Expand Down
37 changes: 27 additions & 10 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
name: nf-core AWS full size tests
# This workflow is triggered on published releases.
# This workflow is triggered on PRs opened against the master branch.
# It can be additionally triggered manually with GitHub actions workflow dispatch button.
# It runs the -profile 'test_full' on AWS batch

on:
release:
types: [published]
pull_request:
branches:
- master
workflow_dispatch:
pull_request_review:
types: [submitted]

jobs:
run-tower:
run-platform:
name: Run AWS full tests
if: github.repository == 'nf-core/epitopeprediction'
# run only if the PR is approved by at least 2 reviewers and against the master branch or manually triggered
if: github.repository == 'nf-core/epitopeprediction' && github.event.review.state == 'approved' && github.event.pull_request.base.ref == 'master' || github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
steps:
- name: Launch workflow via tower
- uses: octokit/[email protected]
id: check_approvals
with:
route: GET /repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- id: test_variables
if: github.event_name != 'workflow_dispatch'
run: |
JSON_RESPONSE='${{ steps.check_approvals.outputs.data }}'
CURRENT_APPROVALS_COUNT=$(echo $JSON_RESPONSE | jq -c '[.[] | select(.state | contains("APPROVED")) ] | length')
test $CURRENT_APPROVALS_COUNT -ge 2 || exit 1 # At least 2 approvals are required
- name: Launch workflow via Seqera Platform
uses: seqeralabs/action-tower-launch@v2
with:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
Expand All @@ -28,9 +45,9 @@ jobs:
}
profiles: test_full

- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
with:
name: Tower debug log file
name: Seqera Platform debug log file
path: |
tower_action_*.log
tower_action_*.json
seqera_platform_action_*.log
seqera_platform_action_*.json
14 changes: 7 additions & 7 deletions .github/workflows/awstest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ name: nf-core AWS test
on:
workflow_dispatch:
jobs:
run-tower:
run-platform:
name: Run AWS tests
if: github.repository == 'nf-core/epitopeprediction'
runs-on: ubuntu-latest
steps:
# Launch workflow using Tower CLI tool action
- name: Launch workflow via tower
# Launch workflow using Seqera Platform CLI tool action
- name: Launch workflow via Seqera Platform
uses: seqeralabs/action-tower-launch@v2
with:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
Expand All @@ -25,9 +25,9 @@ jobs:
}
profiles: test

- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
with:
name: Tower debug log file
name: Seqera Platform debug log file
path: |
tower_action_*.log
tower_action_*.json
seqera_platform_action_*.log
seqera_platform_action_*.json
2 changes: 1 addition & 1 deletion .github/workflows/branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
# NOTE - this doesn't currently work if the PR is coming from a fork, due to limitations in GitHub actions secrets
- name: Post PR comment
if: failure()
uses: mshick/add-pr-comment@v1
uses: mshick/add-pr-comment@b8f338c590a895d50bcbfa6c5859251edc8952fc # v2
with:
message: |
## This PR is against the `master` branch :x:
Expand Down
Loading
Loading