diff --git a/docs/examples/nf-fgsv/index.html b/docs/examples/nf-fgsv/index.html index 0b8b4e3..01e84bd 100644 --- a/docs/examples/nf-fgsv/index.html +++ b/docs/examples/nf-fgsv/index.html @@ -922,6 +922,7 @@ class="fixed top-0 left-0 right-0 h-14 bg-white border-b border-slate-200 z-50 flex items-center px-4 md:px-6" > + + @@ -962,6 +964,7 @@
This page documents all workflows in the pipeline.
- - +main.nf:19
+ Defined in main.nf:35
Detect structural-variant breakpoints from aligned reads using fgsv.
+The --input sample sheet provides one sample identifier and bam path per
+row (see the --input parameter for the full column specification). Every
+per-sample output — the sorted BAM, SvPileup BAM and text, aggregated
+breakpoints, and BEDPE — is published via the sample_outputs topic into a
+directory named after the sample's meta.id. For each sample the workflow runs:
COORDINATE_SORT — coordinate-sort the input BAM with samtools.SV_PILEUP — gather read-level evidence for structural variants (fgsv SvPileup).AGGREGATE_SV_PILEUP — merge pileups that likely support the same breakpoint.AGGREGATE_SV_PILEUP_TO_BEDPE — convert the aggregated breakpoints to BEDPE.This page documents all processes in the pipeline.
- - +val(meta), path(bam), path(txt) meta
tupleval
meta: Map containing sample information (must include 'id'); bam: Input BAM file; txt: SvPileup breakpoint output file
Map containing sample information (must include 'id')
bam
+ path
+ Input BAM file
txt
+ path
+ SvPileup breakpoint output file
val(meta), file("*_svpileup.aggregate.txt") meta:tuplerecord
txtaggregated
Tuple of meta and aggregated SvPileup output file
Record of meta and the aggregated SvPileup output file (txt)
val(meta), path(txt) meta
+ val
+ Map containing sample information (must include 'id')
txt
tuplepath
meta: Map containing sample information (must include 'id'); txt: Aggregated SvPileup output file
Aggregated SvPileup output file
val(meta), file("*_svpileup.aggregate.bedpe") meta:tuplerecord
Tuple of meta and BEDPE format output file
Record of meta and the BEDPE format output file (bedpe)
val(meta), path(bam) meta
+ val
+ Map containing sample information (must include 'id')
bam
tuplepath
meta: Map containing sample information (must include 'id'); bam: Input BAM file to be sorted
Input BAM file to be sorted
val(meta), file("*_sorted.bam") meta:tuplerecord
bamsorted
Tuple of meta and coordinate-sorted BAM file
Record of meta and the coordinate-sorted BAM file (bam)
modules/sv_pileup.nf:11
+ Defined in modules/sv_pileup.nf:10
val(meta), path(bam) meta
tupleval
meta: Map containing sample information (must include 'id'); bam: Input BAM file
Map containing sample information (must include 'id')
bam
+ path
+ Input BAM file
val(meta), file("*_svpileup.txt") meta:tuplerecord
txt
-
- Tuple of meta and SvPileup breakpoint output file
val(meta), file("*_svpileup.bam")
- tuple
- bamresult
Tuple of meta and SvPileup BAM file
Record of meta, the SvPileup BAM file (bam), and the breakpoint output file (txt)