Skip to content

Commit 426c219

Browse files
committed
Reformatted README.md
1 parent fc75c11 commit 426c219

1 file changed

Lines changed: 14 additions & 16 deletions

File tree

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,14 @@
1010
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1111
GNU General Public License for more details.
1212

13-
14-
##############################################################################
1513
# AlignmentProcessor1.1 Package
1614

17-
# Dependencies:
18-
Python 3
19-
Python 3 version of Biopython
20-
PAML (if using CodeML)
21-
PhyML (if using CodeML)
22-
##############################################################################
15+
# Dependencies:
16+
Python 3
17+
Python 3 version of Biopython
18+
PAML (if using CodeML)
19+
PhyML (if using CodeML)
20+
2321

2422
AlignmentProcessor is a pipeline meant to quickly convert a multi-fasta
2523
alignment file into a format that can be read by KaKs_Calculator or PAML and
@@ -31,15 +29,15 @@ based off of its sequences.
3129
You can run the AlignmentProcessor wrapper which will call all of the python
3230
scripts in sequence, or you may call each script individually.
3331

34-
### Installation
32+
# Installation
3533

36-
# GitHub
34+
### GitHub
3735
AlignmentProcessor is freely available on GitHub and can either be downloaded directly from the site,
3836
can cloned using the following command:
3937

4038
git clone https://github.com/WilsonSayresLab/AlignmentProcessor.git
4139

42-
# Installing Biopython
40+
### Installing Biopython
4341
Since Biopython offers the fastest and easiest ways to deal with alignments
4442
in a python script, it is used in several of the scripts in this package.
4543
The easiest way to install Biopython is to download a Python 3 version
@@ -52,25 +50,25 @@ a terminal and Anaconda will install Biopython for you:
5250

5351
conda install -c https://conda.anaconda.org/anaconda biopython
5452

55-
# KaKs_Calculator
53+
### KaKs_Calculator
5654
AlignmentProcessor0.21 is packaged with KaKs_Calculator2.0 binaries for Linux
5755
and Windows, and a KaKs_Calculator1.2 binary for Mac (there is no 2.0 binary
5856
available for OSX). Before using, copy or move the appropriate binary for your
5957
system into the AlignmentProcessor bin which contains the python scripts.
6058

61-
# PAML
59+
### PAML
6260
If you plan to use CodeML, you must first download PAML
6361
(http://abacus.gene.ucl.ac.uk/software/paml.html) and move the folder into the
6462
AlignmentProcessor directory. Make sure that it is titled "paml".
6563

66-
# PhyML
64+
### PhyML
6765
If you plan to use CodeML, you must also download PhyML
6866
(http://www.atgc-montpellier.fr/phyml/binaries.php). Similar to PAML, you must
6967
move the folder into the AlignmentProcessor directory and change the name of
7068
both the folder and the binary for your operating system to "PhyML".
7169

72-
### Quick Start
70+
# Quick Start
7371

7472
python AlignmentProcessor.py --axt/phylip --kaks/codeml -r <reference species> -i <input fasta file> -o <path to output directory>
7573

76-
# Please see AlignmentPRocessorReadMe.pdf for specific options and instructions.
74+
### Please see AlignmentProcessorReadMe.pdf for specific options and instructions.

0 commit comments

Comments
 (0)