Skip to main content

Excel report from viral sequencing analysis output

Project description

xlavir

https://img.shields.io/pypi/v/xlavir.svg https://github.com/peterk87/xlavir/workflows/CI/badge.svg?branch=master Documentation Status

Excel report from viral sequencing data analysis output from the nf-core/viralrecon or peterk87/nf-virontus Nextflow pipelines.

Features

  • Collect sample results from a nf-core/viralrecon or peterk87/nf-virontus into a Excel report
    • Samtools read mapping stats (flagstat)

    • Mosdepth read mapping coverage information

    • Variant calling information (SnpEff and SnpSift results, VCF file information)

    • Consensus sequences

  • QA/QC of sample analysis results (basic PASS/FAIL based on minimum genome coverage and depth)

  • Nextflow workflow execution information

  • Prepend worksheets from other Excel documents into the report (e.g. cover page/sheet, sample sheet, lab results)

  • Add custom images into worksheets with custom names and descriptions (e.g. phylogenetic tree figure PNG)

Roadmap

  • Bcftools variant calling stats sheet

  • Sample metadata table to merge with certain stats?

  • YAML config to info sheet?

  • coverage chart with controls?

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.2.0 (2021-03-04)

  • Added header comments with descriptions of field content

  • Added comment to Variant Matrix sheet A1 cell describing what is shown in the matrix

  • Added highlighting of samples failing QC in other sheets

  • Fixed image scaling by determining image size with imageio

  • Added Medaka / Longshot VCF parsing

0.1.1 (2021-02-16)

  • Collect sample results from a nf-core/viralrecon or peterk87/nf-virontus into a Excel report
    • Samtools read mapping stats (flagstat)

    • Mosdepth read mapping coverage information

    • Variant calling information (SnpEff and SnpSift results, VCF file information)

    • Consensus sequences

  • iVar VCF parsing

  • QA/QC of sample analysis results (basic PASS/FAIL based on minimum genome coverage and depth)

  • Nextflow workflow execution information

  • Prepend worksheets from other Excel documents into the report (e.g. cover page/sheet, sample sheet, lab results)

  • Add custom images into worksheets with custom names and descriptions (e.g. phylogenetic tree figure PNG)

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

xlavir-0.2.2.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

xlavir-0.2.2-py2.py3-none-any.whl (24.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file xlavir-0.2.2.tar.gz.

File metadata

  • Download URL: xlavir-0.2.2.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for xlavir-0.2.2.tar.gz
Algorithm Hash digest
SHA256 f837aee8c6e011fec7e2777c6e0a8ff5d5702ae3e1691ac5cc72d0cef8e12ddb
MD5 e235b962200c9dc03c27c0ea2e68e2e6
BLAKE2b-256 a74591205c4a105dce956b4deb1f507a6e3578facf3c4d69745ba86da5656c02

See more details on using hashes here.

File details

Details for the file xlavir-0.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: xlavir-0.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for xlavir-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4101b66abf78f331c89e627591f4711e8f47831179199a2625e51cefdfc262c9
MD5 4984ef657c0cde7bf673b6f610e6634a
BLAKE2b-256 c1251b54bf3ddfda0e7de56252e2be97ae1a33fff677c887c8901e172a6f7924

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