Skip to content

Commit e65cf89

Browse files
authored
Update README.md
1 parent c6d6240 commit e65cf89

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,14 @@ In order to perform the optional base quality score recalibration, several files
7070
|--input_folder | a folder with fastq files or bam files |
7171
|--input_file | input tabulation-separated values file with columns SM (sample name), RG (read group), pair1 (first fastq pair file), and pair2 (second fastq pair file) |
7272

73-
Note that there are two input methods: folder and file. Although the input folder method is the easiest because it does not require to create an input file with the right format, the input file mode is recommended in cases when a single sample has multiple paired files (e.g., due to multiplexed sequencing); in that case, users should have one line per pair of file and put a same SM identifier so that the workflow can group them into the same output bam file.
73+
Note that there are two input methods: folder and file. Although the input folder method is the easiest because it does not require to create an input file with the right format, the input file mode is recommended in cases when a single sample has multiple paired files (e.g., due to multiplexed sequencing); in that case, users should have one line per pair of file and put a same SM identifier so that the workflow can group them into the same output bam file. For example:
7474

75+
```
76+
SM RG pair1 pair2
77+
sample1 sample1_1.fq.gz sample1_2.fq.gz
78+
sample2 RG1 sample2_RG1_1.fq.gz sample2_RG1_2.fq.gz
79+
sample2 RG2 sample2_RG2_1.fq.gz sample2_RG2_2.fq.gz
80+
```
7581

7682
## Parameters
7783

@@ -121,14 +127,14 @@ In order to perform the optional base quality score recalibration, several files
121127
## Usage
122128
To run the pipeline on a series of paired-end fastq files (with suffixes *_1* and *_2*) in folder *fastq*, a reference genome with indexes in folder *ref_genome*, an annotation file ref.gtf, and a bed file ref.bed, one can type:
123129
```bash
124-
nextflow run iarcbioinfo/RNAseq-nf -r v2.2 -profile singularity --input_folder fastq --ref_folder ref_genome --gtf ref.gtf --bed ref.bed
130+
nextflow run iarcbioinfo/RNAseq-nf -r v2.4 -profile singularity --input_folder fastq --ref_folder ref_genome --gtf ref.gtf --bed ref.bed
125131
```
126132
To run the pipeline using conda instead of singularity, replace "-profile singularity" by "-profile conda". To run with your own local software installation, just remove "-profile singularity".
127133

128134
### Single-end fastq mode
129135
Default is adapted to paired-end libraries. To use single-end libraries as input, you must specify the option "--suffix2 null".
130136
```bash
131-
nextflow run iarcbioinfo/RNAseq-nf -r v2.2 -profile singularity --input_folder fastq --ref_folder ref_genome --gtf ref.gtf --bed ref.bed --suffix2 null
137+
nextflow run iarcbioinfo/RNAseq-nf -r v2.4 -profile singularity --input_folder fastq --ref_folder ref_genome --gtf ref.gtf --bed ref.bed --suffix2 null
132138
```
133139
If using "--input_file", you must additionally set the values in column "pair2" to "NO_fastq2". For example the following file input.txt:
134140

@@ -140,7 +146,7 @@ sample2 RG2 sample2_RG2.fq.gz NO_fastq2
140146
```
141147
can be processed with
142148
```bash
143-
nextflow run iarcbioinfo/RNAseq-nf -r v2.2 -profile singularity --input_file input.txt --ref_folder ref_genome --gtf ref.gtf --bed ref.bed --suffix2 null
149+
nextflow run iarcbioinfo/RNAseq-nf -r v2.4 -profile singularity --input_file input.txt --ref_folder ref_genome --gtf ref.gtf --bed ref.bed --suffix2 null
144150
```
145151

146152
### Use hisat2 for mapping

0 commit comments

Comments
 (0)