fgsmk
A set of utility functions for use in Snakemake workflows. Supports Snakemake 8+.
Table of Contents
Recommended Installation
This package is intended for use within a Snakemake workflow project.
Install the Python package and dependency management tool poetry using official documentation.
You must have Python 3.11 or greater available on your system path, which could be managed by mamba, pyenv, or another package manager.
If you have a mamba environment for the parent project, activate it first.
Install with poetry.
poetry install
Usage
Error summary file
Set the onerror directive in a Snakemake workflow to point to the fgsmk.on_error function.
from fgsmk.log import on_error
onerror:
on_error(snakefile=Path(__file__), config=config, log=Path(log))
"""Block of code that gets called if the snakemake pipeline exits with an error."""
This will produce a file error_summary.txt containing the last (up to) 50 lines of the log files of any rules that failed execution.
The content will also be output to stdout.
Development and Testing
See the contributing guide for more information.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fgsmk-1.0.0.tar.gz.
File metadata
- Download URL: fgsmk-1.0.0.tar.gz
- Upload date:
- Size: 10.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
14bcb6d862337edd4781ffd9048906b5149378d7ba11a81ec4f4ea8fb3f182c9
|
|
| MD5 |
ba65a6820afa3e496b08b4d339afba30
|
|
| BLAKE2b-256 |
6cad580dcc7bb14825f445228f5e269e7d85dcd7a58cba36cb10c451e126c5ca
|
Provenance
The following attestation bundles were made for fgsmk-1.0.0.tar.gz:
Publisher:
publish_fgsmk.yml on fulcrumgenomics/fgsmk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fgsmk-1.0.0.tar.gz -
Subject digest:
14bcb6d862337edd4781ffd9048906b5149378d7ba11a81ec4f4ea8fb3f182c9 - Sigstore transparency entry: 2875927901
- Sigstore integration time:
-
Permalink:
fulcrumgenomics/fgsmk@d806d9122cab4ecd6558558373e16cd5d46efad6 -
Branch / Tag:
refs/tags/1.0.0 - Owner: https://github.com/fulcrumgenomics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_fgsmk.yml@d806d9122cab4ecd6558558373e16cd5d46efad6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file fgsmk-1.0.0-py3-none-any.whl.
File metadata
- Download URL: fgsmk-1.0.0-py3-none-any.whl
- Upload date:
- Size: 9.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ccf67752bdc6fbd4a72df1a5db01b61242761978dd68d071c719be5aeb861b0
|
|
| MD5 |
1ee9e06b1378f8fcae33b51e88ef1a34
|
|
| BLAKE2b-256 |
4b193a0f7cb4744c0cdceeaf503ca83c0e1cda93541358b061124c81eb206bb2
|
Provenance
The following attestation bundles were made for fgsmk-1.0.0-py3-none-any.whl:
Publisher:
publish_fgsmk.yml on fulcrumgenomics/fgsmk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fgsmk-1.0.0-py3-none-any.whl -
Subject digest:
0ccf67752bdc6fbd4a72df1a5db01b61242761978dd68d071c719be5aeb861b0 - Sigstore transparency entry: 2875928571
- Sigstore integration time:
-
Permalink:
fulcrumgenomics/fgsmk@d806d9122cab4ecd6558558373e16cd5d46efad6 -
Branch / Tag:
refs/tags/1.0.0 - Owner: https://github.com/fulcrumgenomics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_fgsmk.yml@d806d9122cab4ecd6558558373e16cd5d46efad6 -
Trigger Event:
push
-
Statement type:
