Skip to content

Commit

Permalink
added additional custom.config tip
Browse files Browse the repository at this point in the history
  • Loading branch information
lianov committed Oct 3, 2024
1 parent dcd435c commit 1ef28d1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,28 @@ process
}
```

We further note that while we encourage the use of `split_amount` as discussed above for larger datasets, the pipeline can be executed without enabling this parameter. When doing this, please consider increasing the time limit to `CORRECT_BARCODES` as it can take hours instead of minutes when `split_amount` is disabled:


```groovy title="custom.config"
//NOTE: with split_amount disabled, consider increasing the time limit to CORRECT_BARCODES
process
{
withName: '.*:CORRECT_BARCODES'
{
time = '15.h'
}
}
```

## Credits

nf-core/scnanoseq was originally written by [Austyn Trull](https://github.com/atrull314), and [Dr. Lara Ianov](https://github.com/lianov).

We would also like to thank the following people and groups for their support, including financial support:

- Dr. Elizabeth Worthey
- University of Alabama at Birmingham Biological Data Science Core (U-BDS), RRID:SCR_021766, https://github.com/U-BDS
- University of Alabama at Birmingham Biological Data Science Core (U-BDS), RRID:SCR_021766, <https://github.com/U-BDS>
- Support from: 3P30CA013148-48S8

## Contributions and Support
Expand Down
12 changes: 6 additions & 6 deletions docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
- [UCSC](#ucsc) - Annotation BED file
- [Quality Control](#quality-control)
- [FastQC](#fastqc) - FASTQ QC
- [Nanocomp](#nanocomp) - Long Read FASTQ QC
- [Nanoplot](#nanoplot) - Long Read FASTQ QC
- [NanoComp](#nanocomp) - Long Read FASTQ QC
- [NanoPlot](#nanoplot) - Long Read FASTQ QC
- [ToulligQC](#toulligqc) - Long Read FASTQ QC
- [RSeQC](#rseqc) - Various RNA-seq QC metrics
- [Read Counts](#read-counts) - Read Counts QC
Expand Down Expand Up @@ -262,7 +262,7 @@ _High level statistics are provided in the MultiQC report, as show in this image
The FastQC plots displayed in the MultiQC report shows _untrimmed_ reads. They may contain adapter sequence and potentially regions with low quality.
:::

### Nanocomp
### NanoComp

<details markdown="1">
<summary>Output files</summary>
Expand All @@ -280,9 +280,9 @@ The FastQC plots displayed in the MultiQC report shows _untrimmed_ reads. They m
![Nanocomp](images/nanocomp_1.png)
![Nanocomp](images/nanocomp_2.png)

[Nanocomp](https://github.com/wdecoster/nanocomp) compares multiple runs of long read sequencing data and alignments. It creates violin plots or box plots of length, quality and percent identity and creates dynamic, overlaying read length histograms and a cumulative yield plot
[NanoComp](https://github.com/wdecoster/nanocomp) compares multiple runs of long read sequencing data and alignments. It creates violin plots or box plots of length, quality and percent identity and creates dynamic, overlaying read length histograms and a cumulative yield plot

### Nanoplot
### NanoPlot

<details markdown="1">
<summary>Output files</summary>
Expand All @@ -302,7 +302,7 @@ The FastQC plots displayed in the MultiQC report shows _untrimmed_ reads. They m
![Nanoplot](images/nanoplot_1.png)
![Nanoplot](images/nanoplot_2.png)

[Nanoplot](https://github.com/wdecoster/NanoPlot) is a plotting tool for long read sequencing data and alignments.
[NanoPlot](https://github.com/wdecoster/NanoPlot) is a plotting tool for long read sequencing data and alignments.

### ToulligQC

Expand Down

0 comments on commit 1ef28d1

Please sign in to comment.