seqan / product_backlog

This repository is used as product backlog for all SeqAn relevant backlog items. This is intended to organise the work for the team.
2 stars 1 forks source link

io: Make output compression configurable, not just deduction by extension #362

Open marehr opened 3 years ago

marehr commented 3 years ago

Description

When we changed the behaviour to write out .gz from compressing via bgzf to gzip, we noticed that it might be desirable to be able to specify which compression you want to use when writing out a file.

@h-2 Showed that some tools, like VCF tools, seem to write out bgzf if they can. We haven't looked whether a normal .gz file is being accepted or not, or whether some tools that read in those file will not work if they get normal gz (non bgzf) file fed.

See the discussion here: https://github.com/seqan/seqan3/issues/2455#issuecomment-819684943

Acceptance Criteria

Tasks

- [ ] task 1 - [ ] task 2 - [ ] task 3 ### Definition of Done - [ ] Implementation and design approved - [ ] Unit tests pass - [ ] Test coverage = 100% - [ ] Microbenchmarks added and/or affected microbenchmarks < 5% performance drop - [ ] API documentation added - [ ] Tutorial/teaching material added - [ ] Test suite compiles in less than 30 seconds (on travis) - [ ] Changelog entry added