You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+3-42Lines changed: 3 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -680,36 +680,6 @@ Recent updates to Samtools have been introduced, which can speed-up performance
680
680
The current workflow does not handle duplex UMIs (i.e. where opposite strands of a duplex molecule have been tagged with a different UMI), and best practices have been proposed to process this type of data.
681
681
Both changes will be implemented in a future release.
682
682
683
-
## How to run sarek when no(t all) reference files are in igenomes
684
-
685
-
For common genomes, such as GRCh38 and GRCh37, the pipeline is shipped with (almost) all necessary reference files. However, sometimes it is necessary to use custom references for some or all files:
686
-
687
-
### No igenomes reference files are used
688
-
689
-
If none of your required genome files are in igenomes, `--igenomes_ignore` must be set to ignore any igenomes input and `--genome null`. The `fasta` file is the only required input file and must be provided to run the pipeline. All other possible reference file can be provided in addition. For details, see the paramter documentation.
690
-
691
-
Minimal example for custom genomes:
692
-
693
-
```
694
-
nextflow run nf-core/sarek --genome null --igenomes_ignore --fasta <custom.fasta>
695
-
```
696
-
697
-
### Overwrite specific reference files
698
-
699
-
If you don't want to use some of the provided reference genomes, they can be overwritten by either providing a new file or setting the respective file parameter to `false`, if it should be ignored:
700
-
701
-
Example for using a custom known indels file:
702
-
703
-
```
704
-
nextflow run nf-core/sarek --known_indels <my_known_indels.vcf.gz> --genome GRCh38.GATK
705
-
```
706
-
707
-
Example for not using known indels, but all other provided reference file:
708
-
709
-
```
710
-
nextflow run nf-core/sarek --known_indels false --genome GRCh38.GATK
711
-
```
712
-
713
683
### Where do the used reference genomes originate from
714
684
715
685
_under construction - help needed_
@@ -874,18 +844,9 @@ nextflow run download_cache.nf --cadd_cache </path/to/CADD/cache> --cadd_version
874
844
Resource requests are difficult to generalize and are often dependent on input data size. Currently, the number of cpus and memory requested by default were adapted from tests on 5 ICGC paired whole-genome sequencing samples with approximately 40X and 80X depth.
875
845
For targeted data analysis, this is overshooting by a lot. In this case resources for each process can be limited by either setting `--max_memory` and `-max_cpus` or tailoring the request by process name as described [here](#resource-requests). If you are using sarek for a certain data type regulary, and would like to make these requests available to others on your system, an institution-specific, pipeline-specific config file can be added [here](https://github.com/nf-core/configs/tree/master/conf/pipeline/sarek).
876
846
877
-
For mapping, sarek follows the parameter suggestions provided in this [paper](https://www.nature.com/articles/s41467-018-06159-4):
878
-
879
-
`-K 100000000`:for deterministic pipeline results, for more info see [here](https://github.com/CCDG/Pipeline-Standardization/issues/2)
880
-
881
-
`-Y`: force soft-clipping rather than default hard-clipping of supplementary alignments
882
-
883
-
In addition, currently, reads with tumor status in the sample sheet are mapped with a mismatch penalty of `-B 3`.
884
-
885
847
## Spark related issues
886
848
887
-
If you have problems running processes that make use of Spark such as `MarkDuplicates`.
888
-
You are probably experiencing issues with the limit of open files in your system.
849
+
If you have problems running processes that make use of Spark such, for instance, as `MarkDuplicates`, then that might be due to a limit on the number of simultaneously open files on your system.
889
850
You can check your current limit by typing the following:
890
851
891
852
```bash
@@ -926,9 +887,9 @@ Currently, when running spark-based tools in combination with docker, it is requ
926
887
927
888
Sarek can process UMI-reads, using [fgbio](http://fulcrumgenomics.github.io/fgbio/tools/latest/) tools.
928
889
929
-
In order to use reads containing UMI tags as your initial input, you need to include `--umi_read_structure [structure]`in your parameters.
890
+
In order to use reads containing UMI tags as your initial input, you need to include `--umi_read_structure <UMI_string>`in your parameters.
930
891
931
-
This will enable pre-processing of the reads and UMI consensus reads calling, which will then be used to continue the workflow from the mapping steps. For post-UMI processing depending on the experimental setup, duplicate marking and base quality recalibration can be skipped with [`--skip_tools`].
892
+
This will enable pre-processing of the reads and UMI consensus reads calling, which will then be used to continue the workflow from the mapping steps. For post-UMI processing depending on the experimental setup, duplicate marking and base quality recalibration can be skipped with `--skip_tools`.
0 commit comments