Skip to content

Conversation

@JackCurragh
Copy link
Contributor

I had added the three module required for running the RiboCode application for detecting translated regions from Ribo-Seq data. This involves preparing the annotations (ribocode/prepare), assessing the alignment files (ribocode/metaplots) and finally running the calling (ribocode/ribocode)

PR checklist

Closes Very Old Issue

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the versions.yml file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

Copy link
Member

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work! Just need some bits and pieces to fix it up

'biocontainers/ribocode:1.2.15--pyhfa5458b_0' }"

input:
path fasta
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inputs and outputs will need to be tuples with meta elements

path gtf

output:
path "annotation" , emit: annotation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metas


output:
path "annotation" , emit: annotation
path "versions.yml" , emit: versions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Versions will be collected via topic channels from now on (there's a bulk conversion in process). You might as well have that in place now- check out https://github.com/nf-core/modules/blob/master/modules/nf-core/ribodetector/main.nf for how it's done.


"""
# nf-core: ensure FASTA is uncompressed
GENOME="$fasta"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't bake this sort of concern into modules I think, keep things simple, pipelines can input gunzip processes.

fi

# Update the GTF
GTFupdate \\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be a separate module

identifier: ""

input:
- fasta:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be updated to allow for the meta structure I indicated above

"id": "test",
"single_end": false
},
"test_ORFs_category.pdf:md5,a56356649534ea846fe7aa3aac6684ff"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably shouldn't try to snapshot pdfs, they tend not to be stable over multiple machines because of differences in underlying libraries.

"id": "test",
"single_end": false
},
"SRX11780887.Aligned.toTranscriptome.out_psites.hd5:md5,802ec4fe5545dec4fe8affd79716faeb"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hd5 is a binary format also likely to work poorly with snapshots

ext.args = '-f0_percent 0.1 -pv1 1 -pv2 1'
}
withName: RIBOCODE_RIBOCODE {
ext.args = ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need this if you're not setting anything


input:
tuple val(meta), path(bam)
path annotation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still need a tuple with a meta

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new module: RiboCode

3 participants