Skip to content

Conversation

@LeonHafner
Copy link
Contributor

@LeonHafner LeonHafner commented Sep 26, 2025

This PR adds support for specifying a custom suffix, so pipeline maintainers can work with files beyond just .csv and .tsv.

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

@LeonHafner LeonHafner self-assigned this Sep 26, 2025
@LeonHafner LeonHafner added the enhancement New feature or request label Sep 26, 2025
Copy link
Member

@mahesh-panchal mahesh-panchal left a comment

Choose a reason for hiding this comment

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

In my opinion the file ending should only be an input:. I don't see the case where a user needs to change it, as it could lead to downstream instability.

@LeonHafner
Copy link
Contributor Author

I’m fine with any solution that lets me use it for files other than CSV and TSV.

Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

@LeonHafner , what exactly do you want to be able to do?

@LeonHafner
Copy link
Contributor Author

Currently, you can edit arbitrary text files delimited by any character by specifying the separator in the in_type and out_type inputs. However, the output file will always have a .csv or .tsv extension. This isn’t catastrophic, but it’s still poor practice, especially when working with formats like GFF.

@mahesh-panchal
Copy link
Member

Our apologies for the delay in reviewing this, but there's a proposal open to the core team that needs voting that directly affects whether or not this pattern should be used. nf-core/proposals#69

@SPPearce
Copy link
Contributor

One option is to just use the suffix of the original file.

@mahesh-panchal
Copy link
Member

One option is to just use the suffix of the original file.

Does one need to worry about compression? Can this module read compressed input?

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants