fastq-handler (original) (raw)

Project description

PyPI version PyPI pyversions PyPI license PyPI format

A python module to process ONT fastq files by concatenating reads as they are generated during a sequencing run

INTRODUCTION

The fastqc-handler module screens folders and subfolders for fastq (fastq or fastq.gz format) files and concatenates them iteratively. This is useful for merging same-sample reads that are split into multiple files, as commonly obtained in ONT sequencing. The output is a one file per output fastq.gz, containing all reads from the previous files. The output directory structure is maintained.

INPUT

A directory containing fastq files. The files can be in subfolders (each representing a different sample). The files can be gzipped or not.

API

usage: fastq_handler [-h] -i IN_DIR -o OUT_DIR [-s SLEEP] [-n TAG] [--keep_names] [--monitor] [--max-size MAX_SIZE] [--downsize] [--merge]

Process fastq files.

optional arguments: -h, --help show this help message and exit -i IN_DIR, --in_dir IN_DIR Input directory -o OUT_DIR, --out_dir OUT_DIR Output directory -s SLEEP, --sleep SLEEP Sleep time -n TAG, --tag TAG name tag, if given, will be added to the output file names --keep_names keep original file names --monitor run indefinitely --max-size MAX_SIZE max size of the output file, in kilobytes --downsize downsize fastq files to max-size --merge merge files

REQUIREMENTS

Modules

INSTALLATION

python -m venv .venv source .venv/bin/activate python -m pip install fastq-handler

MAIN OUTPUTS

Note: The output directory structure is maintained.

Maintainers

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 fastq_handler-0.2.0.tar.gz.

File metadata

File hashes

Hashes for fastq_handler-0.2.0.tar.gz | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | 554d5bd5c617a59541e032492ada5fd5df9483d8449f9edf6905858ca934e430 | | | MD5 | 96ba4a0c34b87fac509eb23d7116c4f5 | | | BLAKE2b-256 | fbfbe6d35c162dda80590c5086fec022e8525545ae978055c25b74bd80cda1f5 | |

See more details on using hashes here.

File details

Details for the file fastq_handler-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fastq_handler-0.2.0-py3-none-any.whl | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | 0cd9ef0b617266632c9d179392bb1f97bf947cef6cfee42ed1e201f554dcaf9c | | | MD5 | 3cb8a39a112369b093dcab7739266531 | | | BLAKE2b-256 | b90b19aa1b5143fb3e10c7f4a2a57027adcb6552305e543e72ee8559a5914164 | |

See more details on using hashes here.