Skip to content

Commit 15d8890

Browse files
committed
update usage doc for input file to indicate need for unique name
1 parent 266c18b commit 15d8890

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ Usage:
6060
6161
Input:
6262
* --input_bam: the path to a single BAM (this option is not compatible with --input_files)
63-
* --input_files: the path to a tab-separated values file containing in each row the sample name, sample type (eg: tumor or normal) and path to the BAM file (this option is not compatible with --input_bam)
63+
* --input_files: the path to a tab-separated values file containing in each row the sample name, sample type (eg: tumor or normal) and path to the BAM file. The sample name should be unique for each bam file. (this option is not compatible with --input_bam)
6464
Sample type will be added to the BAM header @SN sample name
6565
The input file does not have header!
6666
Example input file:
67-
name1 tumor tumor.1.bam
68-
name1 normal normal.1.bam
69-
name2 tumor tumor.2.bam
67+
name1_t tumor tumor.1.bam
68+
name1_n normal normal.1.bam
69+
name2_t tumor tumor.2.bam
7070
* --reference: path to the FASTA genome reference (indexes expected *.fai, *.dict)
7171
7272
Optional input:

nextflow.config

+4-4
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ Usage:
6767
6868
Input:
6969
* --input_bam: the path to a single BAM (this option is not compatible with --input_files)
70-
* --input_files: the path to a tab-separated values file containing in each row the sample name, sample type (eg: tumor or normal) and path to the BAM file (this option is not compatible with --input_bam)
70+
* --input_files: the path to a tab-separated values file containing in each row the sample name, sample type (eg: tumor or normal) and path to the BAM file. The sample name should be unique for each bam file. (this option is not compatible with --input_bam)
7171
Sample type will be added to the BAM header @SN sample name
7272
The input file does not have header!
7373
Example input file:
74-
name1 tumor tumor.1.bam
75-
name1 normal normal.1.bam
76-
name2 tumor tumor.2.bam
74+
name1_t tumor tumor.1.bam
75+
name1_n normal normal.1.bam
76+
name2_t tumor tumor.2.bam
7777
* --reference: path to the FASTA genome reference (indexes expected *.fai, *.dict)
7878
7979
Optional input:

0 commit comments

Comments
 (0)