Skip to main content

BuddySuite is a collection of command line utilities written in Python for working with biological data.

Project description

Build_Status Coverage_Status PyPi_version

BuddySuite


Description

The BuddySuite modules are ‘one-stop-shop’ command-line tools for common biological data file manipulations. Formats are detected automatically, conversions are seamless, and you can pipe into or out of the modules to build custom bioinformatics workflows, allowing you to spend more time analyzing your sequences, alignments, and phylogenetic trees, instead of wrangling them.

For example, the following command reads in three sequence files (all in different formats), pulls out records with RefSeq identifiers, calls MAFFT to generate an alignment, shifts gaps to force a codon alignment, calls RAxML to infer a phylogeny, and then roots the tree at its midpoint.

$: seqbuddy seqs1.gb seqs2.embl seqs3.fasta --pull_records "[XN]M" | alignbuddy --generate_alignment mafft | alignbuddy --enforce_triplets | phylobuddy --generate_tree raxmlHPC-SSE3 | phylobuddy --root

BuddySuite is a Python3 project, developed and extensively tested on Linux and Mac OS X. Full release versions are also tested on Windows before release, so should work as expected on Vista and above.

Getting started

The simplest way to get up and running is:

$: pip install buddysuite
$: buddysuite -setup

Further instructions are available in the installation guide.

There is also a Beginners’ Guide to show you the basics, as well as a more comprehensive Tutorial.

Each tool in the BuddySuite has been extensively documented in the wiki, complete with worked examples and explanations for all arguments/options.

Developers

All of the individual Buddy toolkits are located in the ‘buddysuite’ directory and the ‘develop’ branch is where all new features have been implemented. If you’re interested in contributing, please refer to the developer page for further information.

Citation

We are currently working on a manuscript for peer review, but until then there is a pre-print on bioRxiv that can be cited if you use BuddySuite in your work.

DOI

Contact

Any comments you have would be really appreciated. Please feel free to add issues in the GitHub issue tracker or contact Steve Bond (lead developer) directly at steve.bond@nih.gov.

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

buddysuite-1.2.7.tar.gz (133.8 kB view details)

Uploaded Source

File details

Details for the file buddysuite-1.2.7.tar.gz.

File metadata

  • Download URL: buddysuite-1.2.7.tar.gz
  • Upload date:
  • Size: 133.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for buddysuite-1.2.7.tar.gz
Algorithm Hash digest
SHA256 d50513ca24c03c2c60a709c1cb4f99cf23adc6684ed2ab3c5f792ca3f68a1ecf
MD5 34604699928e6ba1087d3864da17beef
BLAKE2b-256 f0b01bb368adcca37f773c2432ed58a8862a136d1aa960f6a98a0f222c7d5894

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