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 (from *_clade_result.txt)

    summary_all_gene_family.png

  • gene_family/{FamilyID}_gene_family.[png|jpg|svg|pdf]
    Significant expansion(red)/contraction(blue) gene family result

    gene_family.png

  • result_summary.tsv (example)
    Significant expansion/contraction result summary for each family and taxon

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.2.0.tar.gz (362.4 kB view details)

Uploaded Source

Built Distribution

cafeplotter-0.2.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cafeplotter-0.2.0.tar.gz
  • Upload date:
  • Size: 362.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1011-azure

File hashes

Hashes for cafeplotter-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a03551158d7d991514c7f53f88dd92c49e0935ae9a344f1a1c95c8d79505bb85
MD5 88e5c3701090378f4552f9600c9b413a
BLAKE2b-256 61ad606104fa23f01c3c65c4e8c510006d3c0228d50496d0188e43c2e0b90a3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cafeplotter-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1011-azure

File hashes

Hashes for cafeplotter-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be91a0479b0abfa65987abf83d26ba36079d2f0d1992302de67ca798ba6c3b44
MD5 f836913c2d629f85f1d690781358869f
BLAKE2b-256 e0e568b5b62408f84947e645407f46942b07688392989c9a469e8df87c3e554a

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