Skip to content

Commit

Permalink
Name change: Skierfe -> Nallo (genomic-medicine-sweden#39)
Browse files Browse the repository at this point in the history
Co-authored-by: Anders Jemt <[email protected]>
  • Loading branch information
fellen31 and jemten authored Apr 22, 2024
1 parent 642621c commit c2d717c
Show file tree
Hide file tree
Showing 44 changed files with 140 additions and 171 deletions.
16 changes: 8 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# genomic-medicine-sweden/skierfe: Contributing Guidelines
# genomic-medicine-sweden/nallo: Contributing Guidelines

Hi there!
Many thanks for taking an interest in improving genomic-medicine-sweden/skierfe.
Many thanks for taking an interest in improving genomic-medicine-sweden/nallo.

We try to manage the required tasks for genomic-medicine-sweden/skierfe using GitHub issues, you probably came to this page when creating one.
We try to manage the required tasks for genomic-medicine-sweden/nallo using GitHub issues, you probably came to this page when creating one.
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 ;)

## Contribution workflow

If you'd like to write some code for genomic-medicine-sweden/skierfe, the standard workflow is as follows:
If you'd like to write some code for genomic-medicine-sweden/nallo, the standard workflow is as follows:

1. Check that there isn't already an issue about your idea in the [genomic-medicine-sweden/skierfe issues](https://github.com/genomic-medicine-sweden/skierfe/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 [genomic-medicine-sweden/skierfe repository](https://github.com/genomic-medicine-sweden/skierfe) to your GitHub account
1. Check that there isn't already an issue about your idea in the [genomic-medicine-sweden/nallo issues](https://github.com/genomic-medicine-sweden/nallo/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 [genomic-medicine-sweden/nallo repository](https://github.com/genomic-medicine-sweden/nallo) 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).
5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged
Expand Down Expand Up @@ -58,7 +58,7 @@ These tests are run both with the latest available version of `Nextflow` and als

## Pipeline contribution conventions

To make the genomic-medicine-sweden/skierfe code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.
To make the genomic-medicine-sweden/nallo code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.

### Adding a new step

Expand Down Expand Up @@ -108,7 +108,7 @@ This repo includes a devcontainer configuration which will create a GitHub Codes

To get started:

- Open the repo in [Codespaces](https://github.com/genomic-medicine-sweden/skierfe/codespaces)
- Open the repo in [Codespaces](https://github.com/genomic-medicine-sweden/nallo/codespaces)
- Tools installed
- nf-core
- Nextflow
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ body:
* OS _(eg. CentOS Linux, macOS, Linux Mint)_
* Version of genomic-medicine-sweden/skierfe _(eg. 1.1, 1.5, 1.8.2)_
* Version of genomic-medicine-sweden/nallo _(eg. 1.1, 1.5, 1.8.2)_
"
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ contact_links:
about: Please join the nf-core community here
- name: ""
url: https://google.com
about: Discussion about the nf-core/skierfe pipeline
about: Discussion about the nf-core/nallo pipeline
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feature request
description: Suggest an idea for the genomic-medicine-sweden/skierfe pipeline
description: Suggest an idea for the genomic-medicine-sweden/nallo pipeline
labels: enhancement
body:
- type: textarea
Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<!--
# genomic-medicine-sweden/skierfe pull request
# genomic-medicine-sweden/nallo pull request
Many thanks for contributing to genomic-medicine-sweden/skierfe!
Many thanks for contributing to genomic-medicine-sweden/nallo!
Please fill in the appropriate checklist below (delete whatever is not relevant).
These are the most common things requested on pull requests (PRs).
Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.
Learn more about contributing: [CONTRIBUTING.md](https://github.com/genomic-medicine-sweden/skierfe/tree/master/.github/CONTRIBUTING.md)
Learn more about contributing: [CONTRIBUTING.md](https://github.com/genomic-medicine-sweden/nallo/tree/master/.github/CONTRIBUTING.md)
-->

## 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](https://github.com/genomic-medicine-sweden/skierfe/tree/master/.github/CONTRIBUTING.md)
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/genomic-medicine-sweden/nallo/tree/master/.github/CONTRIBUTING.md)
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Ensure the test suite passes (`nf-test test main.nf.test -profile test,docker`).
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
jobs:
run-tower:
name: Run AWS full tests
if: github.repository == 'fellen31/skierfe'
if: github.repository == 'fellen31/nallo'
runs-on: ubuntu-latest
steps:
- name: Launch workflow via tower
Expand All @@ -22,10 +22,10 @@ jobs:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
access_token: ${{ secrets.TOWER_ACCESS_TOKEN }}
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/skierfe/work-${{ github.sha }}
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/nallo/work-${{ github.sha }}
parameters: |
{
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/skierfe/results-${{ github.sha }}"
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/nallo/results-${{ github.sha }}"
}
profiles: test_full,aws_tower
- uses: actions/upload-artifact@v3
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/awstest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
jobs:
run-tower:
name: Run AWS tests
if: github.repository == 'fellen31/skierfe'
if: github.repository == 'fellen31/nallo'
runs-on: ubuntu-latest
steps:
# Launch workflow using Tower CLI tool action
Expand All @@ -17,10 +17,10 @@ jobs:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
access_token: ${{ secrets.TOWER_ACCESS_TOKEN }}
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/skierfe/work-${{ github.sha }}
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/nallo/work-${{ github.sha }}
parameters: |
{
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/skierfe/results-test-${{ github.sha }}"
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/nallo/results-test-${{ github.sha }}"
}
profiles: test,aws_tower
- uses: actions/upload-artifact@v3
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ jobs:
steps:
# PRs to the nf-core repo master branch are only ok if coming from the nf-core repo `dev` or any `patch` branches
- name: Check PRs
if: github.repository == 'genomic-medicine-sweden/skierfe'
if: github.repository == 'genomic-medicine-sweden/nallo'
run: |
{ [[ ${{github.event.pull_request.head.repo.full_name }} == genomic-medicine-sweden/skierfe ]] && [[ $GITHUB_HEAD_REF == "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
{ [[ ${{github.event.pull_request.head.repo.full_name }} == genomic-medicine-sweden/nallo ]] && [[ $GITHUB_HEAD_REF == "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
# If the above check failed, post a comment on the PR explaining the failure
# NOTE - this doesn't currently work if the PR is coming from a fork, due to limitations in GitHub actions secrets
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
test:
name: Run pipeline with test data
# Only run on push if this is the nf-core dev branch (merged PRs)
if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'genomic-medicine-sweden/skierfe') }}"
if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'genomic-medicine-sweden/nallo') }}"
runs-on: ubuntu-latest
strategy:
matrix:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/fix-linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
if: >
contains(github.event.comment.html_url, '/pull/') &&
contains(github.event.comment.body, '@nf-core-bot fix linting') &&
github.repository == 'genomic-medicine-sweden/skierfe'
github.repository == 'genomic-medicine-sweden/nallo'
runs-on: ubuntu-latest
steps:
# Use the @nf-core-bot token to check out so we can push later
Expand Down Expand Up @@ -85,4 +85,4 @@ jobs:
issue-number: ${{ github.event.issue.number }}
body: |
@${{ github.actor }} I tried to fix the linting errors, but it didn't work. Please fix them manually.
See [CI log](https://github.com/genomic-medicine-sweden/skierfe/actions/runs/${{ github.run_id }}) for more details.
See [CI log](https://github.com/genomic-medicine-sweden/nallo/actions/runs/${{ github.run_id }}) for more details.
12 changes: 6 additions & 6 deletions .nf-core.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
lint:
files_exist:
- CODE_OF_CONDUCT.md
- assets/nf-core-skierfe_logo_light.png
- docs/images/nf-core-skierfe_logo_light.png
- docs/images/nf-core-skierfe_logo_dark.png
- assets/nf-core-nallo_logo_light.png
- docs/images/nf-core-nallo_logo_light.png
- docs/images/nf-core-nallo_logo_dark.png
- .github/ISSUE_TEMPLATE/config.yml
- .github/workflows/awstest.yml
- .github/workflows/awsfulltest.yml
- conf/modules.config
files_unchanged:
- CODE_OF_CONDUCT.md
- assets/nf-core-skierfe_logo_light.png
- docs/images/nf-core-skierfe_logo_light.png
- docs/images/nf-core-skierfe_logo_dark.png
- assets/nf-core-nallo_logo_light.png
- docs/images/nf-core-nallo_logo_light.png
- docs/images/nf-core-nallo_logo_dark.png
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/CONTRIBUTING.md
multiqc_config:
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# genomic-medicine-sweden/skierfe: Changelog
# genomic-medicine-sweden/nallo: Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## v0.1.0 - [date]

Initial release of genomic-medicine-sweden/skierfe, created with the [nf-core](https://nf-co.re/) template.
Initial release of genomic-medicine-sweden/nallo, created with the [nf-core](https://nf-co.re/) template.

### `Added`

Expand Down
2 changes: 1 addition & 1 deletion CITATIONS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# genomic-medicine-sweden/skierfe: Citations
# genomic-medicine-sweden/nallo: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[![GitHub Actions CI Status](https://github.com/genomic-medicine-sweden/skierfe/actions/workflows/ci.yml/badge.svg)](https://github.com/genomic-medicine-sweden/skierfe/actions/workflows/ci.yml)
[![GitHub Actions Linting Status](https://github.com/genomic-medicine-sweden/skierfe/actions/workflows/linting.yml/badge.svg)](https://github.com/genomic-medicine-sweden/skierfe/actions/workflows/linting.yml)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.XXXXXXX-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.XXXXXXX)
[![GitHub Actions CI Status](https://github.com/genomic-medicine-sweden/nallo/actions/workflows/ci.yml/badge.svg)](https://github.com/genomic-medicine-sweden/nallo/actions/workflows/ci.yml)
[![GitHub Actions Linting Status](https://github.com/genomic-medicine-sweden/nallo/actions/workflows/linting.yml/badge.svg)](https://github.com/genomic-medicine-sweden/nallo/actions/workflows/linting.yml)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.XXXXXXX-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.XXXXXXX)
[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)

[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A523.04.0-23aa62.svg)](https://www.nextflow.io/)
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)
[![Launch on Seqera Platform](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Seqera%20Platform-%234256e7)](https://tower.nf/launch?pipeline=https://github.com/genomic-medicine-sweden/skierfe)
[![Launch on Seqera Platform](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Seqera%20Platform-%234256e7)](https://tower.nf/launch?pipeline=https://github.com/genomic-medicine-sweden/nallo)

## Introduction

**genomic-medicine-sweden/skierfe** is a bioinformatics analysis pipeline for long-read rare disease SV/SNV identification using both PacBio and (targeted) ONT-data. Heavily influenced by best-practice pipelines such as [nf-core/nanoseq](https://github.com/nf-core/nanoseq), [nf-core/sarek](https://nf-co.re/sarek), [nf-core/raredisease](https://nf-co.re/raredisease), [PacBio Human WGS Workflow](https://github.com/PacificBiosciences/pb-human-wgs-workflow-snakemake), [epi2me-labs/wf-human-variation](https://github.com/epi2me-labs/wf-human-variation) and [brentp/rare-disease-wf](https://github.com/brentp/rare-disease-wf).
**genomic-medicine-sweden/nallo** is a bioinformatics analysis pipeline for long-read rare disease SV/SNV identification using both PacBio and (targeted) ONT-data. Heavily influenced by best-practice pipelines such as [nf-core/nanoseq](https://github.com/nf-core/nanoseq), [nf-core/sarek](https://nf-co.re/sarek), [nf-core/raredisease](https://nf-co.re/raredisease), [PacBio Human WGS Workflow](https://github.com/PacificBiosciences/pb-human-wgs-workflow-snakemake), [epi2me-labs/wf-human-variation](https://github.com/epi2me-labs/wf-human-variation) and [brentp/rare-disease-wf](https://github.com/brentp/rare-disease-wf).

<!-- TODO nf-core: Add full-sized test dataset and amend the paragraph below if applicable -->

Expand Down Expand Up @@ -70,7 +70,7 @@ HG005,/path/to/HG005.bam,FAM1,HG003,HG004,2,1
Now, you can run the pipeline using:

```bash
nextflow run genomic-medicine-sweden/skierfe -r dev -profile YOURPROFILE \
nextflow run genomic-medicine-sweden/nallo -r dev -profile YOURPROFILE \
--input samplesheet.csv \
--preset <revio/pacbio/ONT_R10> \
--outdir <OUTDIR> \
Expand All @@ -81,7 +81,7 @@ nextflow run genomic-medicine-sweden/skierfe -r dev -profile YOURPROFILE \
--skip_cnv_calling
```

For more details and further functionality, please refer to the [usage documentation](https://github.com/genomic-medicine-sweden/skierfe/blob/dev/docs/usage.md).
For more details and further functionality, please refer to the [usage documentation](https://github.com/genomic-medicine-sweden/nallo/blob/dev/docs/usage.md).

> [!WARNING]
> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
Expand All @@ -90,12 +90,12 @@ For more details and further functionality, please refer to the [usage documenta
To run in an offline environment, download the pipeline and singularity images using [`nf-core download`](https://nf-co.re/tools/#downloading-pipelines-for-offline-use):

```
nf-core download fellen31/skierfe -r dev
nf-core download genomic-medicine-sweden/nallo -r dev
```

## Credits

genomic-medicine-sweden/skierfe was originally written by Felix Lenner.
genomic-medicine-sweden/nallo was originally written by Felix Lenner.

We thank the following people for their extensive assistance in the development of this pipeline:

Expand All @@ -108,7 +108,7 @@ If you would like to contribute to this pipeline, please see the [contributing g
## Citations

<!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. -->
<!-- If you use genomic-medicine-sweden/skierfe for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->
<!-- If you use genomic-medicine-sweden/nallo for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->

<!-- TODO nf-core: Add bibliography of tools and data used in your pipeline -->

Expand Down
2 changes: 1 addition & 1 deletion assets/adaptivecard.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"size": "Large",
"weight": "Bolder",
"color": "<% if (success) { %>Good<% } else { %>Attention<%} %>",
"text": "genomic-medicine-sweden/skierfe v${version} - ${runName}",
"text": "genomic-medicine-sweden/nallo v${version} - ${runName}",
"wrap": true
},
{
Expand Down
14 changes: 7 additions & 7 deletions assets/email_template.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<meta name="description" content="genomic-medicine-sweden/skierfe: Long-read variant calling pipeline">
<title>genomic-medicine-sweden/skierfe Pipeline Report</title>
<meta name="description" content="genomic-medicine-sweden/nallo: Long-read variant calling pipeline">
<title>genomic-medicine-sweden/nallo Pipeline Report</title>
</head>
<body>
<div style="font-family: Helvetica, Arial, sans-serif; padding: 30px; max-width: 800px; margin: 0 auto;">

<img src="cid:nfcorepipelinelogo">

<h1>genomic-medicine-sweden/skierfe ${version}</h1>
<h1>genomic-medicine-sweden/nallo ${version}</h1>
<h2>Run Name: $runName</h2>

<% if (!success){
out << """
<div style="color: #a94442; background-color: #f2dede; border-color: #ebccd1; padding: 15px; margin-bottom: 20px; border: 1px solid transparent; border-radius: 4px;">
<h4 style="margin-top:0; color: inherit;">genomic-medicine-sweden/skierfe execution completed unsuccessfully!</h4>
<h4 style="margin-top:0; color: inherit;">genomic-medicine-sweden/nallo execution completed unsuccessfully!</h4>
<p>The exit status of the task that caused the workflow execution to fail was: <code>$exitStatus</code>.</p>
<p>The full error message was:</p>
<pre style="white-space: pre-wrap; overflow: visible; margin-bottom: 0;">${errorReport}</pre>
Expand All @@ -27,7 +27,7 @@ <h4 style="margin-top:0; color: inherit;">genomic-medicine-sweden/skierfe execut
} else {
out << """
<div style="color: #3c763d; background-color: #dff0d8; border-color: #d6e9c6; padding: 15px; margin-bottom: 20px; border: 1px solid transparent; border-radius: 4px;">
genomic-medicine-sweden/skierfe execution completed successfully!
genomic-medicine-sweden/nallo execution completed successfully!
</div>
"""
}
Expand All @@ -44,8 +44,8 @@ <h3>Pipeline Configuration:</h3>
</tbody>
</table>

<p>genomic-medicine-sweden/skierfe</p>
<p><a href="https://github.com/genomic-medicine-sweden/skierfe">https://github.com/genomic-medicine-sweden/skierfe</a></p>
<p>genomic-medicine-sweden/nallo</p>
<p><a href="https://github.com/genomic-medicine-sweden/nallo">https://github.com/genomic-medicine-sweden/nallo</a></p>

</div>

Expand Down
Loading

0 comments on commit c2d717c

Please sign in to comment.