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

clipkit - new module #6993

Merged
merged 4 commits into from
Nov 14, 2024
Merged

clipkit - new module #6993

merged 4 commits into from
Nov 14, 2024

Conversation

vagkaratzas
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

@vagkaratzas vagkaratzas self-assigned this Nov 14, 2024
Copy link
Contributor

@nvnieuwk nvnieuwk left a comment

Choose a reason for hiding this comment

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

Some comments :)

clipkit \\
$args \\
$aln

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe rename the clipkit file here to ${prefix}.clipkit that way you are 100% sure it has the correct name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The default functionality is for the tool to just add ".clipkit" to the input file name. We can either overwrite that within the script by passing the -o argument as suggested ( e.g. ${prefix}.clipkit ) or leave it to the user to do that from a nextflow.config through -args. I left it like this because I thought that just adding a suffix to the filename would be the most wanted functionality. Else to achieve this, the user would need to pass the filename as a meta.id, right?

Which is the preferred nf-core way to do this?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd prefer the -o option to stay consistent with all other modules. The input file name can sometimes be changed by another process in a way that the user doesn't want it. This way you can have full control over the file name in the nf-core best-practice way :)

modules/nf-core/clipkit/tests/main.nf.test Outdated Show resolved Hide resolved
Copy link
Contributor

@nvnieuwk nvnieuwk left a comment

Choose a reason for hiding this comment

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

LGTM!

@vagkaratzas vagkaratzas added this pull request to the merge queue Nov 14, 2024
Merged via the queue into master with commit 3ef3602 Nov 14, 2024
15 checks passed
@vagkaratzas vagkaratzas deleted the clipkit branch November 14, 2024 14:11
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.

2 participants