Skip to main content

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

Metadata

Release files for cafeplotter 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cafeplotter 0.2.0
File Size Uploaded
cafeplotter-0.2.0.tar.gz 362.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cafeplotter 0.2.0
File Interpreter ABI Platform
cafeplotter-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 376.6 kB

Release files / cafeplotter-0.2.0.tar.gz

Download URL cafeplotter-0.2.0.tar.gz
Size 362.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a03551158d7d991514c7f53f88dd92c49e0935ae9a344f1a1c95c8d79505bb85
BLAKE2b-256 checksum
How to use checksums
61ad606104fa23f01c3c65c4e8c510006d3c0228d50496d0188e43c2e0b90a3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1011-azure

Release files / cafeplotter-0.2.0-py3-none-any.whl

Download URL cafeplotter-0.2.0-py3-none-any.whl
Size 14.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
be91a0479b0abfa65987abf83d26ba36079d2f0d1992302de67ca798ba6c3b44
BLAKE2b-256 checksum
How to use checksums
e0e568b5b62408f84947e645407f46942b07688392989c9a469e8df87c3e554a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1011-azure

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page