This release is a pre-release and may not be stable for production use.
AAFTF - Automatic Assembly For The Fungi
Authors: Jason Stajich, Jon Palmer and Cheng-Hung Tsai
AAFTF automates draft genome assembly from Illumina short reads (optionally with long reads), with
read trimming and contaminant filtering, assembly, vector and contaminant screening of contigs,
duplicate removal, contig sorting and renaming, and summary statistics including telomere detection.
Each step is a subcommand that can be run on its own, or all together with AAFTF pipeline_short (Illumina), pipeline_long (ONT/PacBio) or pipeline_hybrid.
Documentation: https://aaftf.readthedocs.io/en/latest/
Install
With conda (bioconda) or pixi, from a checkout of this repository:
$ conda env create -f environment.yml && conda activate aaftf # what the pipelines need
$ pixi install -e complete && pixi shell -e complete # or every optional tool too
$ AAFTF dependency # check which tools are found
Docker and Singularity images, the pixi environments and the list of external tools are described in Installation.
Then download the reference databases once (into ~/.cache/aaftf, or the folder(s) in $AAFTF_DB):
$ AAFTF database required # what the default pipelines need
$ AAFTF database taxpurge # sourmash databases for taxpurge (pipelines with -p)
Quick start
# Illumina reads
AAFTF pipeline_short -1 STRAINX_R1.fq.gz -2 STRAINX_R2.fq.gz -o STRAINX -p Ascomycota -c 16 -m 64
# long reads only
AAFTF pipeline_long -lr STRAINX_ont.fq.gz -o STRAINX --genome_size 40m -c 16
# Illumina + long reads
AAFTF pipeline_hybrid -1 STRAINX_R1.fq.gz -2 STRAINX_R2.fq.gz -lr STRAINX_ont.fq.gz -o STRAINX -c 16 -m 64
Each writes STRAINX.final.fasta and prints the assembly statistics. -p/--phylum is optional:
without it the taxonomic screen (taxpurge) is skipped. Steps whose output already exists are skipped,
so an interrupted run can simply be restarted. See
Workflow for each pipeline's steps and files,
and for running the steps one by one.
Commands
AAFTF -h lists the subcommands; AAFTF <command> -h shows its options. Each is documented in
Commands.
| Group | Subcommands |
|---|---|
| Setup | dependency, database |
| Steps | trim, mito, filter, assemble, vecscreen, taxpurge, fcs_screen, covpurge, rmdup, polish, sort, assess, depth |
| Pipeline | pipeline_short, pipeline_long, pipeline_hybrid |
| Utilities | fcs_gx_purge, fix_tbl |
Notes
This is partially a Python rewrite of JAAWS, a Unix shell based cleanup and assembly tool written by Jon. Changes between versions are listed in CHANGELOG.md.
Authors
- Jason Stajich @hyphaltip - http://lab.stajich.org, @hyphaltip.bsky
- Jon Palmer @nextgenusfs - @jonpalmer.bsky
- Cheng-Hung Tsai
Citation
Palmer JM and Stajich JE. (2023). Automatic assembly for the fungi (AAFTF): genome assembly pipeline (v0.5.0). Zenodo. doi: 10.5281/zenodo.1620526
Metadata
Release files for AAFTF 0.8.0b0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aaftf-0.8.0b0.tar.gz | 193.7 kB | Without provenance | Details for aaftf-0.8.0b0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aaftf-0.8.0b0-py3-none-any.whl | Python 3 | none | any | Details for aaftf-0.8.0b0-py3-none-any.whl |
Total release size: 322.4 kB
Release files / aaftf-0.8.0b0.tar.gz
| Download URL | aaftf-0.8.0b0.tar.gz |
|---|---|
| Size | 193.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
06728c90c049d741094c37796bc3bcd398786428ce9811d219e680d3c68ef469
|
|
BLAKE2b-256 checksum How to use checksums |
764faa09e99946607e743b6f8d72b451e88cae14619cbac3e02a9b4e159d19e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / aaftf-0.8.0b0-py3-none-any.whl
| Download URL | aaftf-0.8.0b0-py3-none-any.whl |
|---|---|
| Size | 128.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1a77198ada2efda357bb49abef047c73d12eb584758a5619fe269413f9a53364
|
|
BLAKE2b-256 checksum How to use checksums |
ac8a7622baf964315c6790f7c648ee9631bb8db0f26498b114690466ebdf1f6a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for AAFTF 0.8.0b0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.