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

Polishing for 1.5 release #13

Merged
merged 15 commits into from
Jun 17, 2024

Conversation

MatthiasZepper
Copy link
Member

This PR comprises the bug fix for the thread limit and additionally some polish for the upcoming 1.5 release:

  • Instead of simply passing the --threads setting to the output file writers, do a proper split.
  • Add additional tests for the new features and CLI parameters.
  • Rename variables in the input file readers for consistency with output.
  • Readme updates: Remove all references to single-threaded output compression.
  • Bump the versions of some steps in CI.

tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
tests/auxiliary.rs Fixed Show fixed Hide fixed
src/umi_external.rs Fixed Show fixed Hide fixed
src/umi_external.rs Fixed Show fixed Hide fixed
Copy link

codecov bot commented May 22, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.10%. Comparing base (0ca36af) to head (3585661).

Current head 3585661 differs from pull request most recent head 4af3d9b

Please upload reports for the commit 4af3d9b to get more accurate results.

Files Patch % Lines
src/auxiliary.rs 75.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev      #13      +/-   ##
==========================================
+ Coverage   87.15%   88.10%   +0.95%     
==========================================
  Files           5        5              
  Lines         179      185       +6     
==========================================
+ Hits          156      163       +7     
+ Misses         23       22       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MatthiasZepper
Copy link
Member Author

MatthiasZepper commented May 24, 2024

Docker and Singularity images are broken...🥲

singularity exec ~/APPTAINER/images/umi-transfer\:1.5.0--9e9164aef88a.sif ldd /usr/local/bin/umi-transfer
/usr/local/bin/umi-transfer: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.33' not found (required by /usr/local/bin/umi-transfer)
/usr/local/bin/umi-transfer: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.32' not found (required by /usr/local/bin/umi-transfer)
/usr/local/bin/umi-transfer: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.34' not found (required by /usr/local/bin/umi-transfer)
	linux-vdso.so.1 (0x00007ffcf0f60000)
	libgcc_s.so.1 => /lib/x86_64-linux-gnu/libgcc_s.so.1 (0x000014fd7650e000)
	libm.so.6 => /lib/x86_64-linux-gnu/libm.so.6 (0x000014fd763ca000)
	libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x000014fd761f6000)
	/lib64/ld-linux-x86-64.so.2 (0x000014fd7683f000)

...and fixed with updating to bookworm base images.

>### Performance Note
>
>The decompression and compression used within umi-transfer is single-threaded, so to get the most reads per minute performance, see the [high performance guide](#high-performance-guide)
The tool requires three FastQ files as input. You can manually specify the names and location of the output files with `--out` and `--out2` or the tool will automatically append a `with_UMI` suffix to your input file names. It additionally accepts to choose a custom UMI delimiter with `--delim` and to set the flags `-f`, `-c` and `-z`.
Copy link
Member

Choose a reason for hiding this comment

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

Did we drop support for single-end mode? That would be only two input fastq:s. Mostly just curious

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we dropped that with version 1.0 See the Discontinued Previous Features section in the release notes. It was too much clutter with the previous code organization, which did not cleanly separate the iterators from the file i/o.

After the current refactoring, it would actually not be that hard to bring it back or also enable reading one input stream from stdin. But I also don't see that a singleton feature would be used frequently. Having paired reads to me seems to be the standard in recent years, and old data has no UMIs.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@alneberg alneberg left a comment

Choose a reason for hiding this comment

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

Looks good!

Co-authored-by: Johannes Alneberg <[email protected]>
@MatthiasZepper MatthiasZepper merged commit babdb13 into SciLifeLab:dev Jun 17, 2024
5 checks passed
@MatthiasZepper MatthiasZepper deleted the Improved_thread_setting branch June 17, 2024 16:10
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