Skip to main content

Python Ultilities for art_modern

Project description

art_modern_utils: Python Utilities for art_modern

art-modern-utils badges: GitHub Release License Code style: black

art-modern-utils on PyPI: Python version PyPI - Version PyPI - Downloads

bioRxiv

Here presents art_modern_utils, a collection of Python utilities for art_modern. In detail, it contains:

art-profile-fastqc: A Python script for generating a FASTQC-like report for ART-compatible error profiles

$ art-profile-fastqc --help
usage: art_profile_fastqc.py [-h] [--version] [-i INPUT] [-o OUTPUT] [--dpi DPI] [--figwidth FIGWIDTH] [--figheight FIGHEIGHT]

Generate boxplot from ART profile quality distribution

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -i INPUT, --input INPUT
                        Input file (default: stdin)
  -o OUTPUT, --output OUTPUT
                        Output figure file. If unset, the plot will be shown interactively.
  --dpi DPI             DPI of figure (default: 300)
  --figwidth FIGWIDTH   Figure width (default: 8in)
  --figheight FIGHEIGHT
                        Figure height (default: 6in)

Usage Example:

art-profile-fastqc --input ~/Documents/art_modern/data/Illumina_profiles/HiSeq2kL100R1.txt --output figs/HiSeq2kL100R1.txt.svg

Generating:

HiSeq2kL100R1 QC Result

art-sam-validate: A Python script for validating SAM/BAM files

This script can also be used to check whether the SAM/BAM files generated by aligners, etc., contain valid CIGAR strings that match what is specified in the reference sequence.

This script will work on sequences that are mapped to the opposite strand.

$ art-sam-validate --help
usage: art-sam-validate [-h] ref alignment

Test whether a SAM/BAM is correct.

positional arguments:
  ref         Reference FASTA file
  alignment   Alignment BAM/SAM file

options:
  -h, --help  show this help message and exit

Usage Example:

art-sam-validate \
    ~/Documents/art_modern_benchmark_other_simulators/data/e_coli.fa \
    ~/Documents/art_modern_benchmark_other_simulators/data/e_coli_CNR0028307.bam

Output:

4128472it [00:14, 283405.25it/s]
{'UNALIGNED': 376180, 'POS': 1877049, 'NEG': 1875243}

Meaning that there are 376,180 unaligned reads, with 1,877,049 and 1,875,243 reads aligned to the positive and negative strands, respectively. All reads are aligned without errors in the BAM file.

Copyright

Copyright (C) 2025--2026 YU Zhejian

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

News

1.0.2 (2026-04-04)

  • art-profile-fastqc: Detection of binned quality scores added.
  • Miscellaneous bug fixes.

1.0.1 (2026-04-03)

  • art-profile-fastqc: Figure width, height, and DPI added. Logger added.
  • Miscellaneous bug fixes.

1.0.0 (2026-02-25)

  • Miscellaneous bug fixes.

0.1.0 (2025-11-13)

  • Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

art_modern_utils-1.0.2.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

art_modern_utils-1.0.2-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file art_modern_utils-1.0.2.tar.gz.

File metadata

  • Download URL: art_modern_utils-1.0.2.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for art_modern_utils-1.0.2.tar.gz
Algorithm Hash digest
SHA256 730f436e53290d6178ba9dad733a7bd2285126267a6285ab3026bcfa75962146
MD5 abe2d7098e5278b96711848f6dd5754b
BLAKE2b-256 c7562627ca01710c09ff2a10ad598e1c29ad26df14e1b33e8d16efb0c7f1b774

See more details on using hashes here.

File details

Details for the file art_modern_utils-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for art_modern_utils-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e65f358a4f80fa8c88fc0ecbe136c2dc14869b12780fbaeb24fc792292d5732e
MD5 23a6dc557a58000f0a5bba9932427edb
BLAKE2b-256 0afd84ea9e21aed54ac13a35c641b66f0ac99c1bf609b5d0d091a3b75e935169

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page