Skip to main content

A tool for plotting CAFE5 gene family expansion/contraction result

Project description

CafePlotter

Python3 OS License Latest PyPI version CI

Table of contents

Overview

CAFE (Computational Analysis of gene Family Evolution) is a software to analyze changes in gene family size in a way that accounts for phylogenetic history and provides a statistical foundation for evolutionary inferences.

CAFE5 currently does not provide tools to visualize Expansion/Contraction of gene families on phylogenetic tree. To solve this issue, I developed CafePlotter, a tool for plotting CAFE5 gene family expansion/contraction result.

Installation

Python 3.8 or later is required for installation.

Install PyPI package:

pip install cafeplotter

Usage

Basic Command

cafeplotter -i [CAFE5 result directory] -o [Output directory]

Options

General Options:
  -i IN, --indir IN       CAFE5 result directory as input
  -o OUT, --outdir OUT    Output directory for plotting CAFE5 result
  --format                Output image format ('png'[default]|'jpg'|'svg'|'pdf')
  -v, --version           Print version information
  -h, --help              Show this help message and exit

Figure Appearence Options:
  --fig_height            Figure height per leaf node of tree (Default: 0.5)
  --fig_width             Figure width (Default: 8.0)
  --leaf_label_size       Leaf label size (Default: 12)
  --count_label_size      Gene count label size (Default: 8)
  --innode_label_size     Internal node label size (Default: 0)
  --p_label_size          Branch p-value label size (Default: 0)
  --ignore_branch_length  Ignore branch length for plotting tree (Default: OFF)
  --expansion_color       Plot color of gene family expansion (Default: 'red')
  --contraction_color     Plot color of gene family contraction (Default: 'blue')
  --dpi                   Figure DPI (Default: 300)

Example Command

User can download example dataset (singlelambda.zip):

cafeplotter -i ./examples/singlelambda -o ./singlelambda_plot --ignore_branch_length

Output Contents

  • summary_all_gene_family.[png|jpg|svg|pdf]
    Summary of all expansion/contraction gene family result

    summary_all_gene_family.png

  • summary_significant_gene_family.[png|jpg|svg|pdf]
    Summary of significant expansion/contraction gene family result

    summary_significant_gene_family.png

  • gene_family/{FamilyID}_gene_family.[png|jpg|svg|pdf]
    Significant :red_circle:expansion/:large_blue_circle:contraction gene family result

    gene_family.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

cafeplotter-0.1.1.tar.gz (362.0 kB view details)

Uploaded Source

Built Distribution

cafeplotter-0.1.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file cafeplotter-0.1.1.tar.gz.

File metadata

  • Download URL: cafeplotter-0.1.1.tar.gz
  • Upload date:
  • Size: 362.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1033-azure

File hashes

Hashes for cafeplotter-0.1.1.tar.gz
Algorithm Hash digest
SHA256 9a095654116df651ab9dc3268da14e05ebe46ce5ba7979464b5f425be41692b0
MD5 4ea0fee108a9e57d909d2019fe996979
BLAKE2b-256 56a8e43b99e7089d2bfa8e0f0764e7bf43c30239df6103159ae9af14e50c7393

See more details on using hashes here.

File details

Details for the file cafeplotter-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cafeplotter-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1033-azure

File hashes

Hashes for cafeplotter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ad42ea261140503c83bbb7e5c490010fe7551a2198a35db759c90cfb04279e3f
MD5 ae833ca94cef72f88c6d35a85cda2f5b
BLAKE2b-256 c6f91c408456121d07b7809f465c63b6007a680a49886463d274faa045885880

See more details on using hashes here.

Supported by

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