annotate Roary/README.md @ 3:e95344f6dfc5 draft default tip

Uploaded
author dereeper
date Fri, 12 Nov 2021 16:32:26 +0000
parents c47a5f61bc9f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
1 # Roary - The pan genome pipeline
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
2 Takes annotated assemblies in GFF3 format and calculates the pan genome.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
3
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
4 PLEASE 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
5
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
6 [![Unmaintained](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
7 [![Build Status](https://travis-ci.org/sanger-pathogens/Roary.svg?branch=master)](https://travis-ci.org/sanger-pathogens/Roary)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
8 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-brightgreen.svg)](https://github.com/sanger-pathogens/roary/blob/master/GPL-LICENSE)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
9 [![status](https://img.shields.io/badge/Bioinformatics-10.1093-brightgreen.svg)](https://academic.oup.com/bioinformatics/article/31/22/3691/240757)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
10 [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](http://bioconda.github.io/recipes/roary/README.html)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
11 [![Container ready](https://img.shields.io/badge/container-ready-brightgreen.svg)](https://quay.io/repository/biocontainers/roary)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
12 [![Docker Build Status](https://img.shields.io/docker/build/sangerpathogens/roary.svg)](https://hub.docker.com/r/sangerpathogens/roary)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
13 [![Docker Pulls](https://img.shields.io/docker/pulls/sangerpathogens/roary.svg)](https://hub.docker.com/r/sangerpathogens/roary)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
14 [![codecov](https://codecov.io/gh/sanger-pathogens/roary/branch/master/graph/badge.svg)](https://codecov.io/gh/sanger-pathogens/roary)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
15
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
16 ## Contents
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
17 * [Introduction](#introduction)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
18 * [Installation](#installation)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
19 * [Required dependencies](#required-dependencies)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
20 * [Optional dependencies](#optional-dependencies)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
21 * [Ubuntu/Debian](#ubuntudebian)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
22 * [Debian Testing](#debian-testing)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
23 * [Ubuntu 14\.04/16\.04](#ubuntu-14041604)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
24 * [Ubuntu 12\.04](#ubuntu-1204)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
25 * [Bioconda \- OSX/Linux](#bioconda---osxlinux)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
26 * [Galaxy](#galaxy)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
27 * [GNU Guix](#gnu-guix)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
28 * [Virtual Machine \- OSX/Linux/Windows](#virtual-machine---osxlinuxwindows)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
29 * [Docker \- OSX/Linux/Windows/Cloud](#docker---osxlinuxwindowscloud)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
30 * [Installing from source (advanced Linux users only)](#installing-from-source-advanced-linux-users-only)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
31 * [Ancient systems and versions of perl](#ancient-systems-and-versions-of-perl)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
32 * [Running the tests](#running-the-tests)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
33 * [Versions of software we test against](#versions-of-software-we-test-against)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
34 * [Usage](#usage)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
35 * [License](#license)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
36 * [Feedback/Issues](#feedbackissues)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
37 * [Citation](#citation)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
38 * [Further Information](#further-information)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
39
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
40 ## Introduction
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
41 Roary 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
42
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
43 ## Installation
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
44 Roary has the following dependencies:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
45
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
46 ### Required dependencies
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
47 * [bedtools](https://bedtools.readthedocs.io/en/latest/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
48 * [cd-hit](http://weizhongli-lab.org/cd-hit/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
49 * [ncbi-blast+](https://blast.ncbi.nlm.nih.gov/Blast.cgi?CMD=Web&PAGE_TYPE=BlastDocs&DOC_TYPE=Download)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
50 * [mcl](https://micans.org/mcl/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
51 * [parallel](https://www.gnu.org/software/parallel/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
52 * [prank](http://wasabiapp.org/software/prank/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
53 * [mafft](https://mafft.cbrc.jp/alignment/software/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
54 * [fasttree](http://www.microbesonline.org/fasttree/)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
55
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
56 ### Optional dependencies
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
57 * [kraken](http://ccb.jhu.edu/software/kraken/MANUAL.html)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
58
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
59 There 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
60
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
61 ### Ubuntu/Debian
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
62 #### Debian Testing
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
63 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
64 sudo apt-get install roary
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
65 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
66
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
67 #### Ubuntu 14.04/16.04
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
68 All 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
69
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
70 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
71 sudo apt-get install bedtools cd-hit ncbi-blast+ mcl parallel cpanminus prank mafft fasttree
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
72 sudo cpanm -f Bio::Roary
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
73 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
74
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
75 #### Ubuntu 12.04
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
76 Some of the software versions in apt are quite old so follow the instructions for Bioconda below.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
77
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
78 ### Bioconda - OSX/Linux
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
79 Install conda. Then install bioconda and roary:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
80
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
81 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
82 conda config --add channels r
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
83 conda config --add channels defaults
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
84 conda config --add channels conda-forge
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
85 conda config --add channels bioconda
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
86 conda install roary
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
87 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
88
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
89 ### Galaxy
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
90 Roary is available from the Galaxy toolshed (as is Prokka).
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
91
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
92 ### GNU Guix
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
93 Roary is included in [Guix](https://www.gnu.org/software/guix) and can be installed in the usual way:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
94 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
95 guix package --install roary
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
96 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
97
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
98 ### Virtual Machine - OSX/Linux/Windows
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
99 Roary 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 -> Import Appliance' menu option. The root password is 'manager'.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
100
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
101 ftp://ftp.sanger.ac.uk/pub/pathogens/pathogens-vm/pathogens-vm.latest.ova
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
102
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
103 More 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
104
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
105 ### Docker - OSX/Linux/Windows/Cloud
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
106 We have a docker container which gets automatically built from the latest version of Roary in Debian Med. To install it:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
107
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
108 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
109 docker pull sangerpathogens/roary
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
110 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
111
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
112 To 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:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
113 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
114 docker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/roary roary -f /data /data/*.gff
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
115 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
116
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
117 ### Installing from source (advanced Linux users only)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
118 As 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
119 Download the latest software from (https://github.com/sanger-pathogens/Roary/tarball/master).
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
120
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
121 Choose somewhere to put it, for example in your home directory (no root access required):
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
122
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
123 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
124 cd $HOME
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
125 tar zxvf sanger-pathogens-Roary-xxxxxx.tar.gz
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
126 ls Roary-*
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
127 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
128
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
129 Add the following lines to your $HOME/.bashrc file, or to /etc/profile.d/roary.sh to make it available to all users:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
130
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
131 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
132 export PATH=$PATH:$HOME/Roary-x.x.x/bin
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
133 export PERL5LIB=$PERL5LIB:$HOME/Roary-x.x.x/lib
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
134 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
135 Install the Perl dependencies:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
136
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
137 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
138 sudo 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
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
139 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
140 Install the external dependances either from source or from your packaging system:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
141 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
142 bedtools cd-hit blast mcl GNUparallel prank mafft fasttree
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
143 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
144
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
145 ### Ancient systems and versions of perl
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
146 The 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.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
147
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
148 ### Running the tests
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
149 The test can be run with dzil from the top level directory:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
150
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
151 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
152 dzil test
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
153 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
154
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
155 ### Versions of software we test against
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
156 * Perl 5.14, 5.26
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
157 * cdhit 4.6.8
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
158 * ncbi blast+ 2.6.0
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
159 * mcl 14-137
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
160 * bedtools 2.27.1
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
161 * prank 140603
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
162 * GNU parallel 20170822, 20160722
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
163 * FastTree 2.1.9
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
164
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
165 ## Usage
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
166 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
167 Usage: roary [options] *.gff
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
168
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
169 Options: -p INT number of threads [1]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
170 -o STR clusters output filename [clustered_proteins]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
171 -f STR output directory [.]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
172 -e create a multiFASTA alignment of core genes using PRANK
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
173 -n fast core gene alignment with MAFFT, use with -e
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
174 -i minimum percentage identity for blastp [95]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
175 -cd FLOAT percentage of isolates a gene must be in to be core [99]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
176 -qc generate QC report with Kraken
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
177 -k STR path to Kraken database for QC, use with -qc
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
178 -a check dependancies and print versions
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
179 -b STR blastp executable [blastp]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
180 -c STR mcl executable [mcl]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
181 -d STR mcxdeblast executable [mcxdeblast]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
182 -g INT maximum number of clusters [50000]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
183 -m STR makeblastdb executable [makeblastdb]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
184 -r create R plots, requires R and ggplot2
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
185 -s dont split paralogs
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
186 -t INT translation table [11]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
187 -ap allow paralogs in core alignment
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
188 -z dont delete intermediate files
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
189 -v verbose output to STDOUT
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
190 -w print version and exit
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
191 -y add gene inference information to spreadsheet, doesnt work with -e
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
192 -iv STR Change the MCL inflation value [1.5]
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
193 -h this help message
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
194
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
195 Example: Quickly generate a core gene alignment using 8 threads
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
196 roary -e --mafft -p 8 *.gff
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
197
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
198 For further info see: http://sanger-pathogens.github.io/Roary/
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
199 ```
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
200 For 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).
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
201
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
202 ## License
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
203 Roary is free software, licensed under [GPLv3](https://github.com/sanger-pathogens/Roary/blob/master/GPL-LICENSE).
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
204
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
205 ## Feedback/Issues
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
206 We 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).
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
207
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
208 ## Citation
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
209 If you use this software please cite:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
210
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
211 "Roary: Rapid large-scale prokaryote pan genome analysis",
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
212 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,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
213 Bioinformatics, (2015). doi: http://dx.doi.org/10.1093/bioinformatics/btv421
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
214 [Roary: Rapid large-scale prokaryote pan genome analysis](http://dx.doi.org/10.1093/bioinformatics/btv421)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
215
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
216 ## Further Information
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
217 For more information on this software see:
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
218 * [The Roary website](http://sanger-pathogens.github.io/Roary)
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
219 * [The Jupyter notebook tutorial](https://github.com/sanger-pathogens/pathogen-informatics-training)