Skip to content

Commit 409ec43

Browse files
committed
Merge branch 'main' of github.com:Juke34/AliNe
2 parents 6b279d8 + 0361c15 commit 409ec43

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ Please follow the instructions at the [Singularity website](https://docs.sylabs.
234234
You can first check the available options and parameters by running:
235235

236236
```bash
237-
nextflow run Juke34/AliNe -r v1.4.0 --help
237+
nextflow run Juke34/AliNe -r v1.5.0 --help
238238
```
239239

240240
### Profile
@@ -246,7 +246,7 @@ To run the workflow you must select a profile according to the container platfor
246246
The command will look like that:
247247

248248
```bash
249-
nextflow run Juke34/AliNe -r v1.4.0 -profile docker <rest of paramaters>
249+
nextflow run Juke34/AliNe -r v1.5.0 -profile docker <rest of paramaters>
250250
```
251251

252252
Another profile is available (/!\\ actually not yet implemented):
@@ -256,7 +256,7 @@ Another profile is available (/!\\ actually not yet implemented):
256256
The use of the `slurm` profile will give a command like this one:
257257

258258
```bash
259-
nextflow run Juke34/AliNe -r v1.4.0 -profile singularity,slurm <rest of paramaters>
259+
nextflow run Juke34/AliNe -r v1.5.0 -profile singularity,slurm <rest of paramaters>
260260
```
261261

262262
### Example
@@ -266,7 +266,7 @@ Here, we use the docker container platform, remote read and reference files, spe
266266

267267
```bash
268268
nextflow run Juke34/AliNe \
269-
-r v1.4.0 \
269+
-r v1.5.0 \
270270
-profile docker \
271271
--reads https://github.com/Juke34/AliNe/raw/refs/heads/main/test/illumina/yeast_R1.fastq.gz \
272272
--reference https://raw.githubusercontent.com/Juke34/AliNe/refs/heads/main/test/yeast.fa \
@@ -285,25 +285,25 @@ Test data are included in the AliNe repository in the `test` folder.
285285
Test with short single reads:
286286

287287
```bash
288-
nextflow run -profile docker,test_illumina_single Juke34/AliNe -r v1.4.0
288+
nextflow run -profile docker,test_illumina_single Juke34/AliNe -r v1.5.0
289289
```
290290

291291
Test with short paired reads:
292292

293293
```bash
294-
nextflow run -profile docker,test_illumina_paired Juke34/AliNe -r v1.4.0
294+
nextflow run -profile docker,test_illumina_paired Juke34/AliNe -r v1.5.0
295295
```
296296

297297
Test with ont reads:
298298

299299
```bash
300-
nextflow run -profile docker,test_ont Juke34/AliNe -r v1.4.0
300+
nextflow run -profile docker,test_ont Juke34/AliNe -r v1.5.0
301301
```
302302

303303
Test with pacbio reads:
304304

305305
```bash
306-
nextflow run -profile docker,test_pacbio Juke34/AliNe -r v1.4.0
306+
nextflow run -profile docker,test_pacbio Juke34/AliNe -r v1.5.0
307307
```
308308

309309
On success you should get a message looking like this:

aline.nf

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1456,26 +1456,21 @@ workflow.onComplete {
14561456
/*
14571457
Other aligner?
14581458
- to map ont?
1459-
- Check salmon can be used as aligner?
14601459
- dragmap
1461-
- bowtie1
1462-
1463-
Annotation:
1464-
Star: When annotation is provided star will need read length information to index the reference.
1465-
If no read length provided by the user and several fastq files are provided, only the first one will be used to get the read length (we perform only one index).
14661460
14671461
How to add an aliger ?
1462+
-----------------------
14681463
Add a module,
14691464
In aline.nf
14701465
Add the aligner in the aligner_list
14711466
Import module here
1472-
If behaves differently depending sequencing techniology add condition in the PARAMS CHECK section
1467+
If behaves differently depending sequencing techniology add condition in the PARAMS CHECK sections (module bash.nf)
14731468
If tool need read length guessing add it in the LIBRARY TYPE GUESSING to activate the guessing if read length not provided by user.
14741469
Add in help
14751470
Add in printAlignerOptions
1476-
Add process in the workflow align
1471+
Add aligner process in the main workflow
14771472
Think to convert sam to bam if necessary
14781473
Think to sort bam output if necessary
14791474
Add info in README.md
14801475
Add tool in multiqc config file (at least for fastqc)
1481-
*/
1476+
*/

0 commit comments

Comments
 (0)