Skip to content

Add circlator/all module#11116

Open
cwoodside1278 wants to merge 1 commit intonf-core:masterfrom
cwoodside1278:add_circlator_all_clean
Open

Add circlator/all module#11116
cwoodside1278 wants to merge 1 commit intonf-core:masterfrom
cwoodside1278:add_circlator_all_clean

Conversation

@cwoodside1278
Copy link
Copy Markdown
Contributor

PR checklist

Closes #11010 #11010
Fixed/Updated PR from #11013

  • 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.
  • Broadcast software version numbers to topic: versions - See version_topics
  • 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

Description

Adds a new module for circlator all, which runs the full Circlator pipeline to circularise genome assemblies from long reads (PacBio/Oxford Nanopore). The module takes an input assembly (FASTA) and long reads (FASTA/FASTQ) and outputs a circularised assembly. A stub test is used as the tool requires substantial real long-read data to run successfully.

Note

Singularity not available on local dev machine. Conda test fails due to a known libcrypto incompatibility with the circlator 1.5.5 conda package on modern systems — this is an upstream issue. Docker test passes successfully.
Also, my previous PR I made for this I accidentally committed any2fasta commits. I created this clean PR to fix it.

@cwoodside1278 cwoodside1278 self-assigned this Apr 2, 2026
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: circlator

1 participant