-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add ciri2 module #12224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
razmia02
wants to merge
9
commits into
nf-core:master
Choose a base branch
from
razmia02:add_ciri2_module
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add ciri2 module #12224
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
06e7b4a
Initial module setup
razmia02 5a6dfae
Initial module setup
razmia02 211e4bc
Added input & output channels
razmia02 e82a3c3
Updated main.nf & meta.yml
razmia02 470cf3a
Tests
razmia02 009f71b
Tests passed for local dataset
razmia02 d1c3a2b
All tests passed, ready to submit
razmia02 a93efc2
Added stub test and removed test_data directory
razmia02 41b6400
Resolved all comments
razmia02 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| channels: | ||
| - conda-forge | ||
| - bioconda | ||
| dependencies: | ||
| - "bioconda::ciri2=2.0.6=pl5321hdfd78af_0" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
|
|
||
| process CIRI2 { | ||
| tag "$meta.id" | ||
| label 'process_single' | ||
|
|
||
|
|
||
| conda "${moduleDir}/environment.yml" | ||
| container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ? | ||
| 'https://depot.galaxyproject.org/singularity/ciri2:2.0.6--pl5321hdfd78af_0': | ||
| 'quay.io/biocontainers/ciri2:2.0.6--pl5321hdfd78af_0' }" | ||
|
|
||
| input: | ||
| tuple val(meta), path(sam) // Required input sam_file | ||
| path fasta // optional reference fasta file | ||
| path annotation // optional GTF or GFF3 annotation file | ||
| path ref_dir // optional reference directory path | ||
|
|
||
| output: | ||
|
|
||
| tuple val(meta), path("*.txt"), emit: circrna | ||
| tuple val(meta), path("*.txt.log"), emit: log, optional: true | ||
| tuple val(meta), path("CIRIerror.log"), emit: error_log, optional: true | ||
|
|
||
| tuple val("${task.process}"), val('CIRI2.pl'), eval("CIRI2.pl --help | sed -n 's/^Version:\\s*//p'"), topic: versions, emit: versions_ciri2 | ||
|
|
||
| when: | ||
| task.ext.when == null || task.ext.when | ||
|
|
||
| script: | ||
| def args = task.ext.args ?: '' | ||
| def prefix = task.ext.prefix ?: "${meta.id}" | ||
| def anno = annotation ? "--anno ${annotation}" : "" | ||
| def reference = fasta ? "--ref_file ${fasta}" : "--ref_dir ${ref_dir}" | ||
|
|
||
| """ | ||
| CIRI2.pl \\ | ||
| --in $sam \\ | ||
| --out ${prefix}.txt \\ | ||
| $reference \\ | ||
| $anno \\ | ||
| --thread_num $task.cpus \\ | ||
| $args | ||
| """ | ||
|
|
||
| stub: | ||
| def args = task.ext.args ?: '' | ||
| def prefix = task.ext.prefix ?: "${meta.id}" | ||
|
|
||
| """ | ||
| echo $args | ||
|
|
||
| touch ${prefix}.txt | ||
| """ | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| name: "ciri2" | ||
| description: Circular RNA identification based on multiple seed matching | ||
| keywords: | ||
| - circRNA | ||
| - detection | ||
| - genomics | ||
| - transcriptomics | ||
| tools: | ||
| - "ciri2": | ||
| description: "CIRI2: Circular RNA identification based on multiple seed matching" | ||
| homepage: "https://ciri-cookbook.readthedocs.io/en/latest/CIRI2.html" | ||
| documentation: "https://ciri-cookbook.readthedocs.io/en/latest/CIRI2.html" | ||
| tool_dev_url: "https://github.com/bioinfo-biols/CIRI-full/tree/master/bin/CIRI_v2.0.6" | ||
| doi: "10.1093/bib/bbx014" | ||
| licence: | ||
| - "GPL-2.0-only" | ||
| identifier: "biotools:ciri2" | ||
| input: | ||
| - - meta: | ||
| type: map | ||
| description: | | ||
| Groovy Map containing sample information | ||
| e.g. `[ id:'sample1' ]` | ||
| - sam: | ||
| type: file | ||
| description: Raw SAM file from BWA | ||
| pattern: "*.{sam}" | ||
| ontologies: | ||
| - edam: "http://edamontology.org/format_3462" | ||
| - fasta: | ||
| type: file | ||
| description: Fasta file for reference sequence | ||
| pattern: "*.{fasta, fa}" | ||
| ontologies: | ||
| - edam: "http://edamontology.org/format_1929" | ||
| - annotation: | ||
| type: file | ||
| description: GTF or GFF3 annotation file | ||
| pattern: "*.{gtf, gff, gff3}" | ||
| ontologies: | ||
| - edam: "http://edamontology.org/format_2305" | ||
| - ref_dir: | ||
| type: directory | ||
| description: Directory containing reference files | ||
| output: | ||
| circrna: | ||
| - - meta: | ||
| type: map | ||
| description: | | ||
| Groovy Map containing sample information | ||
| e.g. `[ id:'sample1' ]` | ||
| - "*.txt": | ||
| type: file | ||
| description: Output file containing circRNA list | ||
| pattern: "*.{txt}" | ||
| ontologies: [] | ||
| log: | ||
| - - meta: | ||
| type: map | ||
| description: | | ||
| Groovy Map containing sample information | ||
| e.g. `[ id:'sample1' ]` | ||
| - "*.txt.log": | ||
| type: file | ||
| description: Output log file | ||
| pattern: "*.{txt.log}" | ||
| ontologies: [] | ||
| error_log: | ||
| - - meta: | ||
| type: map | ||
| description: | | ||
| Groovy Map containing sample information | ||
| e.g. `[ id:'sample1' ]` | ||
| - CIRIerror.log: | ||
| type: file | ||
| description: Output error log file | ||
| pattern: "CIRIerror.log" | ||
| ontologies: [] | ||
| versions_ciri2: | ||
| - - ${task.process}: | ||
| type: string | ||
| description: The name of the process | ||
| - CIRI2.pl: | ||
| type: string | ||
| description: The name of the tool | ||
| - CIRI2.pl --help | sed -n 's/^Version:\s*//p': | ||
| type: eval | ||
| description: The expression to obtain the version of the tool | ||
| topics: | ||
| versions: | ||
| - - ${task.process}: | ||
| type: string | ||
| description: The name of the process | ||
| - CIRI2.pl: | ||
| type: string | ||
| description: The name of the tool | ||
| - CIRI2.pl --help | sed -n 's/^Version:\s*//p': | ||
| type: eval | ||
| description: The expression to obtain the version of the tool | ||
| authors: | ||
| - "@razmia02" | ||
| maintainers: | ||
| - "@razmia02" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| nextflow_process { | ||
|
|
||
| name "Test Process CIRI2" | ||
| script "../main.nf" | ||
| process "CIRI2" | ||
| config "./nextflow.config" | ||
| tag "modules" | ||
| tag "modules_nfcore" | ||
| tag "ciri2" | ||
| tag "samtools/view" | ||
|
|
||
| setup { | ||
| run("SAMTOOLS_VIEW") { | ||
| script "../../samtools/view/main.nf" | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end: false ], | ||
| file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/bam/test.rna.paired_end.bam', checkIfExists: true), | ||
| [] | ||
| ] | ||
| input[1] = [ | ||
| [ id:'fasta' ], file(params.modules_testdata_base_path + 'genomics/homo_sapiens/genome/genome.fasta', checkIfExists: true), [] ] | ||
| input[2] = [ [], [] ] | ||
| input[3] = [ [], [] ] | ||
| input[4] = [] | ||
| """ | ||
| } | ||
| } | ||
| } | ||
|
|
||
| test("homo_sapiens - sam - pairedend") { | ||
|
|
||
| when { | ||
| process { | ||
| """ | ||
| input[0] = SAMTOOLS_VIEW.out.sam | ||
| input[1] = file(params.modules_testdata_base_path + 'genomics/homo_sapiens/genome/genome.fasta', checkIfExists: true) | ||
| input[2] = [] | ||
| input[3] = [] | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot( | ||
| file(process.out.circrna[0][1]).name, | ||
| process.out.logfile ? file(process.out.logfile[0][1]).name : null, | ||
| process.out.findAll { key, val -> key.startsWith('versions') } | ||
| ).match() } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| test("homo_sapiens - sam - pairedend -- stub") { | ||
|
|
||
| options "-stub" | ||
|
|
||
| when { | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end: false ], | ||
| file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/bam/test.rna.paired_end.bam', checkIfExists: true) | ||
| ] | ||
| input[1] = file(params.modules_testdata_base_path + 'genomics/homo_sapiens/genome/genome.fasta', checkIfExists: true) | ||
| input[2] = [] | ||
| input[3] = [] | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot( | ||
| process.out.circrna, | ||
| process.out.findAll { key, val -> key.startsWith('versions') } | ||
| ).match() } | ||
|
razmia02 marked this conversation as resolved.
|
||
| ) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| { | ||
| "homo_sapiens - sam - pairedend": { | ||
| "content": [ | ||
| "test.txt", | ||
| null, | ||
| { | ||
| "versions_ciri2": [ | ||
| [ | ||
| "CIRI2", | ||
| "CIRI2.pl", | ||
| "2.0.6" | ||
| ] | ||
| ] | ||
| } | ||
| ], | ||
| "timestamp": "2026-07-24T19:44:07.04302318", | ||
| "meta": { | ||
| "nf-test": "0.9.5", | ||
| "nextflow": "26.04.3" | ||
| } | ||
| }, | ||
| "homo_sapiens - sam - pairedend -- stub": { | ||
| "content": [ | ||
| [ | ||
| [ | ||
| { | ||
| "id": "test", | ||
| "single_end": false | ||
| }, | ||
| "test.txt:md5,d41d8cd98f00b204e9800998ecf8427e" | ||
| ] | ||
| ], | ||
| { | ||
| "versions_ciri2": [ | ||
| [ | ||
| "CIRI2", | ||
| "CIRI2.pl", | ||
| "2.0.6" | ||
| ] | ||
| ] | ||
| } | ||
| ], | ||
| "timestamp": "2026-07-24T19:44:21.142901021", | ||
| "meta": { | ||
| "nf-test": "0.9.5", | ||
| "nextflow": "26.04.3" | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| process { | ||
| withName: 'SAMTOOLS_VIEW' { | ||
| ext.args = '--output-fmt sam' | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.