{"id":32139570,"url":"https://github.com/sanger-pathogens/roary","last_synced_at":"2025-10-21T05:57:10.060Z","repository":{"id":8107369,"uuid":"9522784","full_name":"sanger-pathogens/Roary","owner":"sanger-pathogens","description":"Rapid large-scale prokaryote pan genome analysis","archived":false,"fork":false,"pushed_at":"2022-04-21T06:08:51.000Z","size":18554,"stargazers_count":355,"open_issues_count":192,"forks_count":191,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-10-21T05:57:03.606Z","etag":null,"topics":["bioinformatics","bioinformatics-pipeline","genomics","global-health","infectious-diseases","next-generation-sequencing","pathogen","research","sequencing"],"latest_commit_sha":null,"homepage":"http://sanger-pathogens.github.io/Roary","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sanger-pathogens.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-18T13:53:50.000Z","updated_at":"2025-10-06T07:20:57.000Z","dependencies_parsed_at":"2022-08-06T20:15:29.206Z","dependency_job_id":null,"html_url":"https://github.com/sanger-pathogens/Roary","commit_stats":null,"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"purl":"pkg:github/sanger-pathogens/Roary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanger-pathogens%2FRoary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanger-pathogens%2FRoary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanger-pathogens%2FRoary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanger-pathogens%2FRoary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanger-pathogens","download_url":"https://codeload.github.com/sanger-pathogens/Roary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanger-pathogens%2FRoary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280213279,"owners_count":26291739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bioinformatics","bioinformatics-pipeline","genomics","global-health","infectious-diseases","next-generation-sequencing","pathogen","research","sequencing"],"created_at":"2025-10-21T05:57:09.071Z","updated_at":"2025-10-21T05:57:10.054Z","avatar_url":"https://github.com/sanger-pathogens.png","language":"Perl","readme":"# Roary - The pan genome pipeline\nTakes annotated assemblies in GFF3 format and calculates the pan genome.\n\nPLEASE NOTE: we currently do not have the resources to provide support for Roary, so please do not expect a reply if you flag any issue.\n\n[![Unmaintained](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)   \n[![Build Status](https://travis-ci.org/sanger-pathogens/Roary.svg?branch=master)](https://travis-ci.org/sanger-pathogens/Roary)   \n[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-brightgreen.svg)](https://github.com/sanger-pathogens/roary/blob/master/GPL-LICENSE)   \n[![status](https://img.shields.io/badge/Bioinformatics-10.1093-brightgreen.svg)](https://academic.oup.com/bioinformatics/article/31/22/3691/240757)  \n[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](http://bioconda.github.io/recipes/roary/README.html)  \n[![Container ready](https://img.shields.io/badge/container-ready-brightgreen.svg)](https://quay.io/repository/biocontainers/roary)  \n[![Docker Build Status](https://img.shields.io/docker/build/sangerpathogens/roary.svg)](https://hub.docker.com/r/sangerpathogens/roary)  \n[![Docker Pulls](https://img.shields.io/docker/pulls/sangerpathogens/roary.svg)](https://hub.docker.com/r/sangerpathogens/roary)  \n[![codecov](https://codecov.io/gh/sanger-pathogens/roary/branch/master/graph/badge.svg)](https://codecov.io/gh/sanger-pathogens/roary)\n\n## Contents\n  * [Introduction](#introduction)\n  * [Installation](#installation)\n    * [Required dependencies](#required-dependencies)\n    * [Optional dependencies](#optional-dependencies)\n    * [Ubuntu/Debian](#ubuntudebian)\n      * [Debian Testing](#debian-testing)\n      * [Ubuntu 14\\.04/16\\.04](#ubuntu-14041604)\n      * [Ubuntu 12\\.04](#ubuntu-1204)\n    * [Bioconda \\- OSX/Linux](#bioconda---osxlinux)\n    * [Galaxy](#galaxy)\n    * [GNU Guix](#gnu-guix)\n    * [Virtual Machine \\- OSX/Linux/Windows](#virtual-machine---osxlinuxwindows)\n    * [Docker \\- OSX/Linux/Windows/Cloud](#docker---osxlinuxwindowscloud)\n    * [Installing from source (advanced Linux users only)](#installing-from-source-advanced-linux-users-only)\n    * [Ancient systems and versions of perl](#ancient-systems-and-versions-of-perl)\n    * [Running the tests](#running-the-tests)\n    * [Versions of software we test against](#versions-of-software-we-test-against)\n  * [Usage](#usage)\n  * [License](#license)\n  * [Feedback/Issues](#feedbackissues)\n  * [Citation](#citation)\n  * [Further Information](#further-information)\n\n## Introduction\nRoary is a high speed stand alone pan genome pipeline, which takes annotated assemblies in GFF3 format (produced by Prokka) and calculates the pan genome.  Using a standard desktop PC, it can analyse datasets with thousands of samples, something which is computationally infeasible with existing methods, without compromising the quality of the results.  128 samples can be analysed in under 1 hour using 1 GB of RAM and a single processor. To perform this analysis using existing methods would take weeks and hundreds of GB of RAM.\n\n## Installation\nRoary has the following dependencies:\n\n### Required dependencies\n* [bedtools](https://bedtools.readthedocs.io/en/latest/)\n* [cd-hit](http://weizhongli-lab.org/cd-hit/)\n* [ncbi-blast+](https://blast.ncbi.nlm.nih.gov/Blast.cgi?CMD=Web\u0026PAGE_TYPE=BlastDocs\u0026DOC_TYPE=Download)\n* [mcl](https://micans.org/mcl/)\n* [parallel](https://www.gnu.org/software/parallel/)\n* [prank](http://wasabiapp.org/software/prank/)\n* [mafft](https://mafft.cbrc.jp/alignment/software/)\n* [fasttree](http://www.microbesonline.org/fasttree/)\n\n### Optional dependencies\n* [kraken](http://ccb.jhu.edu/software/kraken/MANUAL.html)\n\nThere are a number of ways to install Roary and details are provided below. If you encounter an issue when installing Roary please contact your local system administrator.\n\n### Ubuntu/Debian\n#### Debian Testing\n```\nsudo apt-get install roary\n```\n\n#### Ubuntu 14.04/16.04\nAll the dependancies can be installed using apt and cpanm. Root permissions are required. Ubuntu 16.04 contains a package for Roary but it is frozen at v3.6.0.\n\n```\nsudo apt-get install bedtools cd-hit ncbi-blast+ mcl parallel cpanminus prank mafft fasttree\nsudo cpanm -f Bio::Roary\n```\n\n#### Ubuntu 12.04\nSome of the software versions in apt are quite old so follow the instructions for Bioconda below.\n\n### Bioconda - OSX/Linux\nInstall conda. Then install bioconda and roary:\n\n```\nconda config --add channels r\nconda config --add channels defaults\nconda config --add channels conda-forge\nconda config --add channels bioconda\nconda install roary\n```\n\n### Galaxy\nRoary is available from the Galaxy toolshed (as is Prokka).\n\n### GNU Guix\nRoary is included in [Guix](https://www.gnu.org/software/guix) and can be installed in the usual way:\n```\nguix package --install roary\n```\n\n### Virtual Machine - OSX/Linux/Windows\nRoary wont run natively on Windows but we have created virtual machine which has all of the software setup, including Prokka, along with the test datasets from the paper. It is based on [Bio-Linux 8](http://environmentalomics.org/bio-linux/).  You need to first install [VirtualBox](https://www.virtualbox.org/), then load the virtual machine, using the 'File -\u003e Import Appliance' menu option. The root password is 'manager'.\n\nftp://ftp.sanger.ac.uk/pub/pathogens/pathogens-vm/pathogens-vm.latest.ova\n\nMore importantly though, if you're trying to do bioinformatics on Windows, you're not going to get very far and you should seriously consider upgrading to Linux.\n\n### Docker - OSX/Linux/Windows/Cloud\nWe have a docker container which gets automatically built from the latest version of Roary in Debian Med. To install it:\n\n```\ndocker pull sangerpathogens/roary\n```\n\nTo use it you would use a command such as this (substituting in your directories), where your GFF files are assumed to be stored in /home/ubuntu/data:\n```\ndocker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/roary roary -f /data /data/*.gff\n```\n\n### Installing from source (advanced Linux users only)\nAs a last resort you can install everything from source. This is for users with advanced Linux skills and we do not provide any support with this method since you have the skills to figure things out.\nDownload the latest software from (https://github.com/sanger-pathogens/Roary/tarball/master).\n\nChoose somewhere to put it, for example in your home directory (no root access required):\n\n```\ncd $HOME\ntar zxvf sanger-pathogens-Roary-xxxxxx.tar.gz\nls Roary-*\n```\n\nAdd the following lines to your $HOME/.bashrc file, or to /etc/profile.d/roary.sh to make it available to all users:\n\n```\nexport PATH=$PATH:$HOME/Roary-x.x.x/bin\nexport PERL5LIB=$PERL5LIB:$HOME/Roary-x.x.x/lib\n```\nInstall the Perl dependencies:\n\n```\nsudo cpanm  Array::Utils Bio::Perl Exception::Class File::Basename File::Copy File::Find::Rule File::Grep File::Path File::Slurper File::Spec File::Temp File::Which FindBin Getopt::Long Graph Graph::Writer::Dot List::Util Log::Log4perl Moose Moose::Role Text::CSV PerlIO::utf8_strict Devel::OverloadInfo Digest::MD5::File\n```\nInstall the external dependances either from source or from your packaging system:\n```\nbedtools cd-hit blast mcl GNUparallel prank mafft fasttree\n```\n\n### Ancient systems and versions of perl\nThe code will not work with perl 5.8 or below (pre-modern perl). We no longer test against 5.10 (released 2007) or 5.12 (released 2010). If you're running a very old verison of Linux, you're also in trouble.\n\n### Running the tests\nThe test can be run with dzil from the top level directory:  \n\n```\ndzil test\n```\n\n### Versions of software we test against\n* Perl 5.14, 5.26\n* cdhit 4.6.8\n* ncbi blast+ 2.6.0\n* mcl 14-137\n* bedtools 2.27.1\n* prank 140603\n* GNU parallel 20170822, 20160722\n* FastTree 2.1.9\n\n## Usage\n```\nUsage:   roary [options] *.gff\n\nOptions: -p INT    number of threads [1]\n         -o STR    clusters output filename [clustered_proteins]\n         -f STR    output directory [.]\n         -e        create a multiFASTA alignment of core genes using PRANK\n         -n        fast core gene alignment with MAFFT, use with -e\n         -i        minimum percentage identity for blastp [95]\n         -cd FLOAT percentage of isolates a gene must be in to be core [99]\n         -qc       generate QC report with Kraken\n         -k STR    path to Kraken database for QC, use with -qc\n         -a        check dependancies and print versions\n         -b STR    blastp executable [blastp]\n         -c STR    mcl executable [mcl]\n         -d STR    mcxdeblast executable [mcxdeblast]\n         -g INT    maximum number of clusters [50000]\n         -m STR    makeblastdb executable [makeblastdb]\n         -r        create R plots, requires R and ggplot2\n         -s        dont split paralogs\n         -t INT    translation table [11]\n         -ap       allow paralogs in core alignment\n         -z        dont delete intermediate files\n         -v        verbose output to STDOUT\n         -w        print version and exit\n         -y        add gene inference information to spreadsheet, doesnt work with -e\n         -iv STR   Change the MCL inflation value [1.5]\n         -h        this help message\n\nExample: Quickly generate a core gene alignment using 8 threads\n         roary -e --mafft -p 8 *.gff\n\nFor further info see: http://sanger-pathogens.github.io/Roary/\n```\nFor further instructions on how to use the software, the input format and output formats, please see [the Roary website](http://sanger-pathogens.github.io/Roary).\n\n## License\nRoary is free software, licensed under [GPLv3](https://github.com/sanger-pathogens/Roary/blob/master/GPL-LICENSE).\n\n## Feedback/Issues\nWe currently do not have the resources to provide support for Roary. However, the community might be able to help you out if you report any issues about usage of the software to the [issues page](https://github.com/sanger-pathogens/Roary/issues).\n\n## Citation\nIf you use this software please cite:\n\n    \"Roary: Rapid large-scale prokaryote pan genome analysis\",\n    Andrew J. Page, Carla A. Cummins, Martin Hunt, Vanessa K. Wong, Sandra Reuter, Matthew T. G. Holden, Maria Fookes, Daniel Falush, Jacqueline A. Keane, Julian Parkhill,\n    Bioinformatics, (2015). doi: http://dx.doi.org/10.1093/bioinformatics/btv421\n[Roary: Rapid large-scale prokaryote pan genome analysis](http://dx.doi.org/10.1093/bioinformatics/btv421)\n\n## Further Information\nFor more information on this software see:\n* [The Roary website](http://sanger-pathogens.github.io/Roary)\n* [The Jupyter notebook tutorial](https://github.com/sanger-pathogens/pathogen-informatics-training)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanger-pathogens%2Froary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanger-pathogens%2Froary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanger-pathogens%2Froary/lists"}