Skip to content
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

Added tantan module #6256

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Added tantan module #6256

wants to merge 1 commit into from

Conversation

CarsonJM
Copy link
Contributor

PR checklist

Closes #XXX

  • 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

@CarsonJM CarsonJM requested a review from a team as a code owner August 22, 2024 22:41
@CarsonJM CarsonJM requested review from koenbossers and removed request for a team August 22, 2024 22:41
@CarsonJM CarsonJM self-assigned this Aug 22, 2024
@CarsonJM CarsonJM added the new module Adding a new module label Aug 22, 2024
@CarsonJM CarsonJM marked this pull request as draft August 22, 2024 22:43
Copy link
Contributor

@charles-plessy charles-plessy left a comment

Choose a reason for hiding this comment

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

I checked nf-test and prettier locally. The tests pass and pettier run --all-files modifies only files outside the modules/nf-core/tantan path. My comments are about the input and output channels of the module.

Comment on lines +23 to +26
- fasta:
type: file
description: FASTA file containing a nucleotide sequence.
pattern: "*.{fa,fa.gz,fasta,fasta.gz,fna,fna.gz}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Tantan also accepts FASTQ input; maybe you can rename the input channel to fastx and expand the pattern to accept fq, fq.gz, fastq and fastq.gz?

description: |
Groovy Map containing sample information
e.g. `[ id:'sample1', single_end:false ]`
- masked_fasta:
Copy link
Contributor

Choose a reason for hiding this comment

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

If you allow FASTQ input then either you need one output channel that will contain FASTA or FASTQ, or you need one separate channel for each format.

description: FASTA file containing a nucleotide sequence.
pattern: "*.{fa,fa.gz,fasta,fasta.gz,fna,fna.gz}"

output:
Copy link
Contributor

Choose a reason for hiding this comment

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

You need to describe the repeat_probs, repeat_counts, bed, and tandem_repeats channels too.

@charles-plessy charles-plessy mentioned this pull request Sep 9, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new module Adding a new module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants