Skip to content

Commit 73c6a33

Browse files
authored
Merge pull request #194 from MaxUlysse/docs
Update docs
2 parents 3485bb7 + 39a7dee commit 73c6a33

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ Piellorieppe is one of the main massif in the Sarek National Park.
5353
- [#141](https://github.com/nf-core/sarek/pull/141) - Update `VEP` databases to `99`
5454
- [#143](https://github.com/nf-core/sarek/pull/143) - Revert `snpEff` cache version to `75` for `GRCh37`
5555
- [#143](https://github.com/nf-core/sarek/pull/143) - Revert `snpEff` cache version to `86` for `GRCh38`
56-
- [#152](https://github.com/nf-core/sarek/pull/152), [#158](https://github.com/nf-core/sarek/pull/158), [#164](https://github.com/nf-core/sarek/pull/164), [#174](https://github.com/nf-core/sarek/pull/174) - Update docs
56+
- [#152](https://github.com/nf-core/sarek/pull/152), [#158](https://github.com/nf-core/sarek/pull/158), [#164](https://github.com/nf-core/sarek/pull/164), [#174](https://github.com/nf-core/sarek/pull/174), [#194](https://github.com/nf-core/sarek/pull/194) - Update docs
5757
- [#164](https://github.com/nf-core/sarek/pull/164) - Update `gatk4-spark` from `4.1.4.1` to `4.1.6.0`
5858
- [#180](https://github.com/nf-core/sarek/pull/180) - Improve minimal setting
59-
- [#183](https://github.com/nf-core/sarek/pull/183) - Update input.md documentation
59+
- [#183](https://github.com/nf-core/sarek/pull/183) - Update `input.md` documentation
6060

6161
### Fixed - [2.6dev]
6262

docs/usage.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@
7474
- [--species](#--species)
7575
- [--vep_cache_version](#--vep_cache_version)
7676
- [--vepCacheVersion](#--vepcacheversion)
77+
- [--annotation_cache](#--annotation_cache)
78+
- [--snpeff_cache](#--snpeff_cache)
79+
- [--vep_cache](#--vep_cache)
7780
- [--igenomes_ignore](#--igenomes_ignore)
7881
- [--igenomesIgnore](#--igenomesignore)
7982
- [Job resources](#job-resources)
@@ -752,6 +755,31 @@ If you prefer, you can specify the cache version when you run the pipeline:
752755
> :warning: This params has been removed.
753756
> Please check: [`--vep_cache_version`](#--vep_cache_version)
754757
758+
### --annotation_cache
759+
760+
Enable usage of annotation cache, and disable usage of already built containers within Sarek.
761+
For more information, follow the [annotation guidelines](annotation.md#using-downloaded-cache).
762+
763+
```bash
764+
--annotation_cache
765+
```
766+
767+
### --snpeff_cache
768+
769+
To be used conjointly with [`--annotation_cache`](#--annotation_cache), specify the cache snpEff directory:
770+
771+
```bash
772+
--snpeff_cache /path/to/snpeff_cache
773+
```
774+
775+
### --vep_cache
776+
777+
To be used conjointly with [`--annotation_cache`](#--annotation_cache), specify the cache VEP directory:
778+
779+
```bash
780+
--vep_cache /path/to/vep_cache
781+
```
782+
755783
### --igenomes_ignore
756784

757785
Do not load `igenomes.config` when running the pipeline.

0 commit comments

Comments
 (0)