Skip to content

Commit

Permalink
back to business
Browse files Browse the repository at this point in the history
  • Loading branch information
FriederikeHanssen committed Aug 18, 2022
1 parent 1a7a571 commit c79acf0
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 21 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Removed

## [3.0.1](https://github.com/nf-core/sarek/releases/tag/3.0.1) - Saiva

Saiva is a lake in the Sarek national park, just below the Skierfe mountain.

### Fixed

- [#708](https://github.com/nf-core/sarek/pull/708) - Fixes mpileup bug. Update nf-core module `samtools/mpileup` to subset CRAM file by intervals.

## [3.0](https://github.com/nf-core/sarek/releases/tag/3.0) - Skierfe

Skierfe is a mountain in the Sarek national park, and the inspiration for the logo.
Expand Down
17 changes: 9 additions & 8 deletions docs/images/sarek_subway.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/sarek_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/images/sarek_workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ See the [`--input`](usage.md#--input) section in the usage documentation for fur
## Variant Calling

The results regarding variant calling are collected in `{outdir}/variantcalling/`.
If some results from a variant caller do not appear here, please check out the `--tools` section in the parameter [documentation](https://nf-co.re/sarek/3.0.0/parameters).
If some results from a variant caller do not appear here, please check out the `--tools` section in the parameter [documentation](https://nf-co.re/sarek/3.0.1/parameters).

(Recalibrated) CRAM files can used as an input to start the variant calling.

Expand Down
12 changes: 6 additions & 6 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,8 +300,8 @@ nextflow pull nf-core/sarek

It is a good idea to specify a pipeline version when running the pipeline on your data. This ensures that a specific version of the pipeline code and software are used when you run your pipeline. If you keep using the same tag, you'll be running the same version of the pipeline, even if there have been changes to the code since.

First, go to the [nf-core/sarek releases page](https://github.com/nf-core/sarek/releases) and find the latest version number - numeric only (eg. `3.0.0`).
Then specify this when running the pipeline with `-r` (one hyphen) - eg. `-r 3.0.0`.
First, go to the [nf-core/sarek releases page](https://github.com/nf-core/sarek/releases) and find the latest version number - numeric only (eg. `3.0.1`).
Then specify this when running the pipeline with `-r` (one hyphen) - eg. `-r 3.0.1`.

This version number will be logged in reports when you run the pipeline, so that you'll know what you used when you look back in the future.

Expand Down Expand Up @@ -483,7 +483,7 @@ If you have any questions or issues please send us a message on [Slack](https://
When using default parameters only, sarek runs preprocessing and exits after base quality score recalibration. This is reflected in the default test profile:

```console
nextflow run nf-core/sarek -r 3.0 -profile test,<container/institute>
nextflow run nf-core/sarek -r 3.0.1 -profile test,<container/institute>
```

Expected run output:
Expand Down Expand Up @@ -533,13 +533,13 @@ Expected run output:
The pipeline comes with a number of possible paths and tools that can be used. The easiest and fastest test to see that the preprocessing + variantcalling (in this case Strelka2) works, is to run:

```console
nextflow run nf-core/sarek -r 3.0.0 -profile test,<container/institute> --tools strelka
nextflow run nf-core/sarek -r 3.0.1 -profile test,<container/institute> --tools strelka
```

Due to the small test data size, unfortunately not everything can be tested from top-to-bottom, but often is done by utilizing the pipeline's `--step` parameter. Annotation has to tested separatly from the remaining workflow, since we use references for `C.elegans`, while the remaining tests are run on downsampled human data.

```console
nextflow run nf-core/sarek -r 3.0.0 -profile test,<container/institute> --tools snpeff --step annotation
nextflow run nf-core/sarek -r 3.0.1 -profile test,<container/institute> --tools snpeff --step annotation
```

If you are interested in any of the other tests that are run on every code change or would like to run them yourself, you can take a look at `tests/<filename>.yml`. For each entry the respective nextflow command run and the expected output is specified.
Expand Down Expand Up @@ -809,4 +809,4 @@ ERROR_CHROMOSOME_NOT_FOUND 17522411

## How to set up sarek to use sentieon

Sarek 3.0 is currently not supporting sentieon. It is planned for the upcoming release 3.1. In the meantime, please revert to the last release 2.7.2.
Sarek 3.0.1 is currently not supporting sentieon. It is planned for the upcoming release 3.1. In the meantime, please revert to the last release 2.7.2.
2 changes: 1 addition & 1 deletion modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@
"git_sha": "720027275ccdc1363bb2a19c6412da148e31d94b"
},
"samtools/mpileup": {
"git_sha": "24e05f6097a5dde57dd80d33295ed120f1b81aef"
"git_sha": "454e0acc09de7cdcc90007420bfe8afa251286fb"
},
"samtools/stats": {
"git_sha": "f48a24770e24358e58de66e9b805a70d77cd154b"
Expand Down
1 change: 1 addition & 0 deletions modules/nf-core/modules/samtools/mpileup/main.nf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ manifest {
mainScript = 'main.nf'
nextflowVersion = '!>=21.10.3'
version = '3.1dev'

}

// Load modules.config for DSL2 module specific options
Expand Down

0 comments on commit c79acf0

Please sign in to comment.