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

fix: for vsearch, fixed bug with bz2 output and added general log #1775

Merged
merged 11 commits into from Dec 18, 2023

Conversation

fgvieira
Copy link
Collaborator

@fgvieira fgvieira commented Aug 31, 2023

Description

Fixed bug with bz2 output and added the general log too keep console clean and be able to keep track of progress.

QC

  • I confirm that:

For all wrappers added by this PR,

  • there is a test case which covers any introduced changes,
  • input: and output: file paths in the resulting rule can be changed arbitrarily,
  • either the wrapper can only use a single core, or the example rule contains a threads: x statement with x being a reasonable default,
  • rule names in the test case are in snake_case and somehow tell what the rule is about or match the tools purpose or name (e.g., map_reads for a step that maps reads),
  • all environment.yaml specifications follow the respective best practices,
  • wherever possible, command line arguments are inferred and set automatically (e.g. based on file extensions in input: or output:),
  • all fields of the example rules in the Snakefiles and their entries are explained via comments (input:/output:/params: etc.),
  • stderr and/or stdout are logged correctly (log:), depending on the wrapped tool,
  • temporary files are either written to a unique hidden folder in the working directory, or (better) stored where the Python function tempfile.gettempdir() points to (see here; this also means that using any Python tempfile default behavior works),
  • the meta.yaml contains a link to the documentation of the respective tool or command,
  • Snakefiles pass the linting (snakemake --lint),
  • Snakefiles are formatted with snakefmt,
  • Python wrapper scripts are formatted with black.
  • Conda environments use a minimal amount of channels, in recommended ordering. E.g. for bioconda, use (conda-forge, bioconda, nodefaults, as conda-forge should have highest priority and defaults channels are usually not needed because most packages are in conda-forge nowadays).

@fgvieira fgvieira changed the title feat: Added general log fix: fixed bug with bz2 output and added general log Aug 31, 2023
@johanneskoester johanneskoester changed the title fix: fixed bug with bz2 output and added general log fix: for vsearch, fixed bug with bz2 output and added general log Oct 30, 2023
bio/vsearch/test/Snakefile Outdated Show resolved Hide resolved
@fgvieira
Copy link
Collaborator Author

Failing due to ensembl_sequence_chromosomes wrapper.

bio/vsearch/test/Snakefile Outdated Show resolved Hide resolved
@fgvieira
Copy link
Collaborator Author

I thought a bit more about the log file and, since it is not exactly the same as the stdout, it makes sense to support it. However, I think having it as verbose might be a bit confusing since it is not clear where that output comes from.
If we leave it an optional output, then it is clear it comes from the vsearch command line argument log (just like all the other outputs).

@johanneskoester
Copy link
Contributor

Mhm, but it will be lost upon error. log is really the right place for these things. If you don't like verbose, maybe call the two logs std and vsearch?

@fgvieira
Copy link
Collaborator Author

That is true, the outputs are lost in error.

@johanneskoester johanneskoester merged commit 28e76d0 into snakemake:master Dec 18, 2023
6 checks passed
@fgvieira fgvieira deleted the vsearch_log branch December 18, 2023 20:26
johanneskoester pushed a commit that referenced this pull request Dec 21, 2023
🤖 I have created a release \*beep\* \*boop\*
---
###
[3.3.2](https://www.github.com/snakemake/snakemake-wrappers/compare/v3.3.1...v3.3.2)
(2023-12-21)


### Bug Fixes

* fix title in ega/fetch metadata
([c8305af](https://www.github.com/snakemake/snakemake-wrappers/commit/c8305afe1afa7fcfa9dc13005d6f2b6bf5741a9a))
* for vsearch, fixed bug with bz2 output and added general log
([#1775](https://www.github.com/snakemake/snakemake-wrappers/issues/1775))
([28e76d0](https://www.github.com/snakemake/snakemake-wrappers/commit/28e76d06362caf61ab033f2259a94fb65e788bd0))
---


This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

None yet

2 participants